tldraw 3.16.0-internal.a478398270c6 → 3.16.0-next.15f085081fd5

package/src/test/selection-omnibus.test.ts

@@ -7,6 +7,7 @@ import {
 	tlenv,
 	toRichText,
 } from '@tldraw/editor'
+import { vi } from 'vitest'
 import { TestEditor } from './TestEditor'
 
 let editor: TestEditor
@@ -1652,7 +1653,7 @@ describe('shift brushes to add to the selection', () => {
 		editor.keyUp('Shift')
 		// there's a timer here—we should keep the shift mode until the timer expires
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box2, ids.box1])
-		jest.advanceTimersByTime(500)
+		vi.advanceTimersByTime(500)
 		// once the timer expires, we should be back in regular mode
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box1])
 		editor.keyDown('Shift')
@@ -1722,7 +1723,7 @@ describe('scribble brushes to add to the selection', () => {
 		editor.pointerMove(50, 50)
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box1, ids.box2])
 		editor.keyUp('Shift')
-		jest.advanceTimersByTime(500)
+		vi.advanceTimersByTime(500)
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box1])
 		editor.keyDown('Shift')
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box1, ids.box2])
@@ -1739,7 +1740,7 @@ describe('scribble brushes to add to the selection', () => {
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box4])
 		editor.keyUp('Alt') // scribble
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box4]) // still in timer
-		jest.advanceTimersByTime(1000) // let timer expire
+		vi.advanceTimersByTime(1000) // let timer expire
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box3, ids.box4]) // brushed!
 		editor.keyDown('Alt') // scribble
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box4]) // back to brushed only
@@ -1824,7 +1825,7 @@ describe('When brushing close to the edges of the screen', () => {
 		editor.pointerMove(300, 300)
 		editor.pointerDown()
 		editor.pointerMove(0, 0)
-		jest.advanceTimersByTime(100)
+		vi.advanceTimersByTime(100)
 		editor.pointerUp()
 		const camera2 = editor.getCamera()
 		expect(camera2.x).toBeGreaterThan(camera1.x) // for some reason > is left
@@ -1837,7 +1838,7 @@ describe('When brushing close to the edges of the screen', () => {
 		editor.pointerMove(300, 300)
 		editor.pointerDown()
 		editor.pointerMove(100, 100)
-		jest.advanceTimersByTime(100)
+		vi.advanceTimersByTime(100)
 		editor.pointerUp()
 		const camera2 = editor.getCamera()
 		// should NOT have moved the camera by edge scrolling
@@ -1851,7 +1852,7 @@ describe('When brushing close to the edges of the screen', () => {
 		editor.pointerMove(300, 300)
 		editor.pointerDown()
 		editor.pointerMove(100, 100)
-		jest.advanceTimersByTime(100)
+		vi.advanceTimersByTime(100)
 		editor.pointerUp()
 		const camera4 = editor.getCamera()
 		// should NOT have moved the camera by edge scrolling because the edge is now "inset"
@@ -1860,7 +1861,7 @@ describe('When brushing close to the edges of the screen', () => {
 
 		editor.pointerDown()
 		editor.pointerMove(90, 90) // off the edge of the component
-		jest.advanceTimersByTime(100)
+		vi.advanceTimersByTime(100)
 		const camera5 = editor.getCamera()
 		// should have moved the camera by edge scrolling off the component edge
 		expect(camera5.x).toBeGreaterThan(camera4.x)
@@ -1882,7 +1883,7 @@ describe('When brushing close to the edges of the screen', () => {
 		editor.pointerMove(0, 0)
 		// still only box 1...
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box1])
-		jest.advanceTimersByTime(100)
+		vi.advanceTimersByTime(100)
 		// ...but now viewport will have moved to select box2 as well
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box1, ids.box2])
 		editor.pointerUp()
@@ -1902,7 +1903,7 @@ describe('When brushing close to the edges of the screen', () => {
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box1])
 		editor.pointerMove(0, 0)
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box1])
-		jest.advanceTimersByTime(100)
+		vi.advanceTimersByTime(100)
 		expect(editor.getSelectedShapeIds()).toEqual([ids.box1])
 		editor.pointerUp()
 	})
@@ -2199,7 +2200,7 @@ describe('long press', () => {
 	it('works correctly with screenbounds offset', () => {
 		editor.updateViewportScreenBounds(new Box(100, 100, 800, 600))
 		editor.pointerDown(201, 202)
-		jest.advanceTimersByTime(1000)
+		vi.advanceTimersByTime(1000)
 		// without the fix added in this PR, it would have been 1, 2
 		expect(editor.inputs.currentScreenPoint).toMatchObject({ x: 101, y: 102 })
 	})

package/src/test/shapeutils.test.ts

@@ -1,4 +1,5 @@
-import { createShapeId, TLFrameShape, TLGeoShape } from '@tldraw/editor'
+import { createShapeId, TLFrameShape, TLGeoShape, TLLineShape } from '@tldraw/editor'
+import { vi } from 'vitest'
 import { TestEditor } from './TestEditor'
 
 let editor: TestEditor
@@ -11,6 +12,8 @@ const ids = {
 	frame1: createShapeId('frame1'),
 	box1: createShapeId('box1'),
 	box2: createShapeId('box2'),
+	line1: createShapeId('line1'),
+	page1: createShapeId('page1'),
 }
 
 beforeEach(() => {
@@ -56,34 +59,93 @@ describe('When interacting with a shape...', () => {
 		// Set start / change / end events on only the geo shape
 		const util = editor.getShapeUtil<TLFrameShape>('frame')
 
-		const fnStart = jest.fn()
-		util.onRotateStart = fnStart
+		const calls: string[] = []
 
-		const fnChange = jest.fn()
-		util.onRotate = fnChange
+		util.onRotateStart = () => {
+			calls.push('start')
+		}
 
-		const fnEnd = jest.fn()
-		util.onRotateEnd = fnEnd
+		util.onRotate = () => {
+			calls.push('change')
+		}
+
+		util.onRotateEnd = () => {
+			calls.push('end')
+		}
 
 		editor.selectAll()
 		expect(editor.getSelectedShapeIds()).toMatchObject([ids.frame1, ids.box1])
 
-		editor
-			.pointerDown(300, 300, {
-				target: 'selection',
-				handle: 'bottom_right_rotate',
-			})
-			.pointerMove(200, 200)
-			.pointerUp(200, 200)
+		editor.pointerDown(300, 300, {
+			target: 'selection',
+			handle: 'bottom_right_rotate',
+		})
 
-		// Once on start (for frame only)
-		expect(fnStart).toHaveBeenCalledTimes(1)
+		// Should not have called any callbacks yet
+		expect(calls).toEqual([])
 
-		// Once on start, once during the move
-		expect(fnChange).toHaveBeenCalledTimes(2)
+		editor.pointerMove(200, 200)
+
+		// Should have called start once and change at least once now
+		expect(calls).toEqual(['start', 'change'])
+
+		editor.pointerMove(200, 210)
 
-		// Once on end
-		expect(fnEnd).toHaveBeenCalledTimes(1)
+		// Should have called start once and change multiple times
+		expect(calls).toEqual(['start', 'change', 'change'])
+
+		editor.pointerUp(200, 210)
+
+		// Should have called end once now
+		expect(calls).toEqual(['start', 'change', 'change', 'change', 'end'])
+	})
+
+	it('fires rotate cancel events', () => {
+		const util = editor.getShapeUtil<TLFrameShape>('frame')
+
+		const calls: string[] = []
+
+		util.onRotateStart = () => {
+			calls.push('start')
+		}
+
+		util.onRotate = () => {
+			calls.push('change')
+		}
+
+		util.onRotateEnd = () => {
+			calls.push('end')
+		}
+
+		util.onRotateCancel = () => {
+			calls.push('cancel')
+		}
+
+		editor.selectAll()
+		expect(editor.getSelectedShapeIds()).toMatchObject([ids.frame1, ids.box1])
+
+		editor.pointerDown(300, 300, {
+			target: 'selection',
+			handle: 'bottom_right_rotate',
+		})
+
+		// Should not have called any callbacks yet
+		expect(calls).toEqual([])
+
+		editor.pointerMove(200, 200)
+
+		// Should have called start once and change at least once now
+		expect(calls).toEqual(['start', 'change'])
+
+		editor.pointerMove(200, 210)
+
+		// Should have called start once and change multiple times
+		expect(calls).toEqual(['start', 'change', 'change'])
+
+		editor.cancel()
+
+		// Should have called cancel instead of end
+		expect(calls).toEqual(['start', 'change', 'change', 'cancel'])
 	})
 
 	it('cleans up events', () => {
@@ -94,7 +156,7 @@ describe('When interacting with a shape...', () => {
 	it('fires double click handler event', () => {
 		const util = editor.getShapeUtil<TLGeoShape>('geo')
 
-		const fnStart = jest.fn()
+		const fnStart = vi.fn()
 		util.onDoubleClick = fnStart
 
 		editor.doubleClick(50, 50, ids.box2)
@@ -105,14 +167,19 @@ describe('When interacting with a shape...', () => {
 	it('Fires resisizing events', () => {
 		const util = editor.getShapeUtil<TLFrameShape>('frame')
 
-		const fnStart = jest.fn()
-		util.onResizeStart = fnStart
+		const calls: string[] = []
+
+		util.onResizeStart = () => {
+			calls.push('start')
+		}
 
-		const fnChange = jest.fn()
-		util.onResize = fnChange
+		util.onResize = () => {
+			calls.push('change')
+		}
 
-		const fnEnd = jest.fn()
-		util.onResizeEnd = fnEnd
+		util.onResizeEnd = () => {
+			calls.push('end')
+		}
 
 		editor.selectAll()
 		expect(editor.getSelectedShapeIds()).toMatchObject([ids.frame1, ids.box1])
@@ -123,54 +190,171 @@ describe('When interacting with a shape...', () => {
 		})
 
 		editor.expectToBeIn('select.pointing_resize_handle')
+
+		// Should not have called any callbacks yet
+		expect(calls).toEqual([])
+
 		editor.pointerMove(200, 200)
 		editor.expectToBeIn('select.resizing')
+
+		// Should have called start once and change at least once now
+		expect(calls).toEqual(['start', 'change'])
+
 		editor.pointerMove(200, 210)
+
+		// Should have called start once and change multiple times
+		expect(calls).toEqual(['start', 'change', 'change'])
+
 		editor.pointerUp(200, 210)
 		editor.expectToBeIn('select.idle')
 
-		// Once on start (for frame only)
-		expect(fnStart).toHaveBeenCalledTimes(1)
+		// Should have called end once now
+		expect(calls).toEqual(['start', 'change', 'change', 'end'])
+	})
+
+	it('Fires resizing cancel events', () => {
+		const util = editor.getShapeUtil<TLFrameShape>('frame')
+
+		const calls: string[] = []
+
+		util.onResizeStart = () => {
+			calls.push('start')
+		}
+
+		util.onResize = () => {
+			calls.push('change')
+		}
+
+		util.onResizeEnd = () => {
+			calls.push('end')
+		}
+
+		util.onResizeCancel = () => {
+			calls.push('cancel')
+		}
+
+		editor.selectAll()
+		expect(editor.getSelectedShapeIds()).toMatchObject([ids.frame1, ids.box1])
+
+		editor.pointerDown(300, 300, {
+			target: 'selection',
+			handle: 'bottom_right',
+		})
+
+		editor.expectToBeIn('select.pointing_resize_handle')
+
+		// Should not have called any callbacks yet
+		expect(calls).toEqual([])
+
+		editor.pointerMove(200, 200)
+		editor.expectToBeIn('select.resizing')
+
+		// Should have called start once and change at least once now
+		expect(calls).toEqual(['start', 'change'])
+
+		editor.pointerMove(200, 210)
+
+		// Should have called start once and change multiple times
+		expect(calls).toEqual(['start', 'change', 'change'])
 
-		// Once on start, once during the resize
-		expect(fnChange).toHaveBeenCalledTimes(2)
+		editor.cancel()
 
-		// Once on end
-		expect(fnEnd).toHaveBeenCalledTimes(1)
+		// Should have called cancel instead of end
+		expect(calls).toEqual(['start', 'change', 'change', 'cancel'])
 	})
 
 	it('Fires translating events', () => {
 		const util = editor.getShapeUtil<TLFrameShape>('frame')
 
-		const fnStart = jest.fn()
-		util.onTranslateStart = fnStart
+		const calls: string[] = []
 
-		const fnChange = jest.fn()
-		util.onTranslate = fnChange
+		util.onTranslateStart = () => {
+			calls.push('start')
+		}
 
-		const fnEnd = jest.fn()
-		util.onTranslateEnd = fnEnd
+		util.onTranslate = () => {
+			calls.push('change')
+		}
+
+		util.onTranslateEnd = () => {
+			calls.push('end')
+		}
 
 		editor.selectAll()
 		expect(editor.getSelectedShapeIds()).toMatchObject([ids.frame1, ids.box1])
 
 		// Translate the shapes...
-		editor.pointerDown(50, 50, ids.box1).pointerMove(50, 40).pointerUp(50, 40)
+		editor.pointerDown(50, 50, ids.box1)
 
-		// Once on start for frame
-		expect(fnStart).toHaveBeenCalledTimes(1)
+		// Should not have called any callbacks yet
+		expect(calls).toEqual([])
+
+		editor.pointerMove(50, 40)
+
+		// Should have called start once and change at least once now
+		expect(calls).toEqual(['start', 'change'])
 
-		// Once on start, once during the move
-		expect(fnChange).toHaveBeenCalledTimes(2)
+		editor.pointerMove(50, 35)
 
-		// Once on end
-		expect(fnEnd).toHaveBeenCalledTimes(1)
+		// Should have called start once and change multiple times
+		expect(calls).toEqual(['start', 'change', 'change'])
+
+		editor.pointerUp(50, 35)
+
+		// Should have called end once now
+		expect(calls).toEqual(['start', 'change', 'change', 'change', 'end'])
+	})
+
+	it('Fires translating cancel events', () => {
+		const util = editor.getShapeUtil<TLFrameShape>('frame')
+
+		const calls: string[] = []
+
+		util.onTranslateStart = () => {
+			calls.push('start')
+		}
+
+		util.onTranslate = () => {
+			calls.push('change')
+		}
+
+		util.onTranslateEnd = () => {
+			calls.push('end')
+		}
+
+		util.onTranslateCancel = () => {
+			calls.push('cancel')
+		}
+
+		editor.selectAll()
+		expect(editor.getSelectedShapeIds()).toMatchObject([ids.frame1, ids.box1])
+
+		// Translate the shapes...
+		editor.pointerDown(50, 50, ids.box1)
+
+		// Should not have called any callbacks yet
+		expect(calls).toEqual([])
+
+		editor.pointerMove(50, 40)
+
+		// Should have called start once and change at least once now
+		expect(calls).toEqual(['start', 'change'])
+
+		editor.pointerMove(50, 35)
+
+		// Should have called start once and change multiple times
+		expect(calls).toEqual(['start', 'change', 'change'])
+
+		editor.cancel()
+
+		// Should have called cancel instead of end
+		expect(calls).toEqual(['start', 'change', 'change', 'cancel'])
 	})
 
 	it('Uses the shape utils onClick handler', () => {
 		const util = editor.getShapeUtil<TLFrameShape>('frame')
 
-		const fnClick = jest.fn()
+		const fnClick = vi.fn()
 		util.onClick = fnClick
 
 		editor.pointerDown(50, 50, ids.frame1)
@@ -184,7 +368,7 @@ describe('When interacting with a shape...', () => {
 	it('Uses the shape utils onClick handler', () => {
 		const util = editor.getShapeUtil<TLFrameShape>('frame')
 
-		const fnClick = jest.fn((shape: any) => {
+		const fnClick = vi.fn((shape: any) => {
 			return {
 				...shape,
 				x: 100,
@@ -201,4 +385,170 @@ describe('When interacting with a shape...', () => {
 		// it should not be selected.
 		expect(editor.getSelectedShapeIds().length).toBe(0)
 	})
+
+	it('Fires handle dragging events', () => {
+		const util = editor.getShapeUtil<TLLineShape>('line')
+
+		const calls: string[] = []
+
+		util.onHandleDragStart = () => {
+			calls.push('start')
+		}
+
+		util.onHandleDrag = () => {
+			calls.push('change')
+		}
+
+		util.onHandleDragEnd = () => {
+			calls.push('end')
+		}
+
+		util.onHandleDragCancel = () => {
+			calls.push('cancel')
+		}
+
+		// Create a line shape with handles
+		const lineShape: TLLineShape = {
+			id: ids.line1,
+			type: 'line',
+			typeName: 'shape',
+			parentId: ids.page1,
+			index: 'a1' as any,
+			x: 100,
+			y: 100,
+			rotation: 0,
+			isLocked: false,
+			opacity: 1,
+			meta: {},
+			props: {
+				dash: 'draw',
+				size: 'm',
+				color: 'black',
+				spline: 'line',
+				scale: 1,
+				points: {
+					a1: { id: 'a1', index: 'a1' as any, x: 0, y: 0 },
+					a2: { id: 'a2', index: 'a2' as any, x: 100, y: 100 },
+				},
+			},
+		}
+
+		editor.createShapes([lineShape])
+
+		// Get the handle point
+		const handlePagePoint = editor
+			.getShapePageTransform(lineShape.id)!
+			.applyToPoint(lineShape.props.points['a2'])
+
+		editor.pointerDown(handlePagePoint.x, handlePagePoint.y, {
+			target: 'handle',
+			shape: editor.getShape(lineShape.id)!,
+			handle: { id: 'a2', type: 'vertex', index: 'a2' as any, x: 100, y: 100 },
+		})
+
+		editor.expectToBeIn('select.pointing_handle')
+
+		// Should not have called any callbacks yet
+		expect(calls).toEqual([])
+
+		editor.pointerMove(handlePagePoint.x + 20, handlePagePoint.y + 20) // Larger move to trigger drag
+		editor.expectToBeIn('select.dragging_handle')
+
+		// Should have called start once and change at least once now
+		expect(calls).toEqual(['start', 'change'])
+
+		editor.pointerMove(150, 150)
+
+		// Should have called start once and change multiple times
+		expect(calls).toEqual(['start', 'change', 'change'])
+
+		editor.pointerUp(150, 150)
+		editor.expectToBeIn('select.idle')
+
+		// Should have called end once now
+		expect(calls).toEqual(['start', 'change', 'change', 'end'])
+	})
+
+	it('Fires handle dragging cancel events', () => {
+		const util = editor.getShapeUtil<TLLineShape>('line')
+
+		const calls: string[] = []
+
+		util.onHandleDragStart = () => {
+			calls.push('start')
+		}
+
+		util.onHandleDrag = () => {
+			calls.push('change')
+		}
+
+		util.onHandleDragEnd = () => {
+			calls.push('end')
+		}
+
+		util.onHandleDragCancel = () => {
+			calls.push('cancel')
+		}
+
+		// Create a line shape with handles
+		const lineShape: TLLineShape = {
+			id: ids.line1,
+			type: 'line',
+			typeName: 'shape',
+			parentId: ids.page1,
+			index: 'a1' as any,
+			x: 100,
+			y: 100,
+			rotation: 0,
+			isLocked: false,
+			opacity: 1,
+			meta: {},
+			props: {
+				dash: 'draw',
+				size: 'm',
+				color: 'black',
+				spline: 'line',
+				scale: 1,
+				points: {
+					a1: { id: 'a1', index: 'a1' as any, x: 0, y: 0 },
+					a2: { id: 'a2', index: 'a2' as any, x: 100, y: 100 },
+				},
+			},
+		}
+
+		editor.createShapes([lineShape])
+
+		// Get the handle point
+		const handlePagePoint = editor
+			.getShapePageTransform(lineShape.id)!
+			.applyToPoint(lineShape.props.points['a2'])
+
+		editor.pointerDown(handlePagePoint.x, handlePagePoint.y, {
+			target: 'handle',
+			shape: editor.getShape(lineShape.id)!,
+			handle: { id: 'a2', type: 'vertex', index: 'a2' as any, x: 100, y: 100 },
+		})
+
+		editor.expectToBeIn('select.pointing_handle')
+
+		// Should not have called any callbacks yet
+		expect(calls).toEqual([])
+
+		editor.pointerMove(handlePagePoint.x + 20, handlePagePoint.y + 20) // Larger move to trigger drag
+		editor.expectToBeIn('select.dragging_handle')
+
+		// Should have called start once and change at least once now
+		expect(calls).toEqual(['start', 'change'])
+
+		editor.pointerMove(150, 150)
+
+		// Should have called start once and change multiple times
+		expect(calls).toEqual(['start', 'change', 'change'])
+
+		editor.cancel()
+		editor.expectToBeIn('select.idle')
+
+		// Should have called cancel instead of end
+		expect(calls).toEqual(['start', 'change', 'change', 'cancel'])
+	})
 })