tldraw 4.3.0-next.705b6ec94f43 → 4.3.0-next.7f179bd04d6c

package/src/test/custom-clipping.test.ts

@@ -8,7 +8,6 @@ import {
 	resizeBox,
 	StateNode,
 	T,
-	TLBaseShape,
 	TLEventHandlers,
 	TLGeoShape,
 	TLResizeInfo,
@@ -19,19 +18,21 @@ import {
 } from '@tldraw/editor'
 import { TestEditor } from './TestEditor'
 
-// Custom Circle Clip Shape Definition
-export type CircleClipShape = TLBaseShape<
-	'circle-clip',
-	{
-		w: number
-		h: number
+const CIRCLE_CLIP_TYPE = 'circle-clip'
+
+declare module '@tldraw/tlschema' {
+	export interface TLGlobalShapePropsMap {
+		[CIRCLE_CLIP_TYPE]: { w: number; h: number }
 	}
->
+}
+
+// Custom Circle Clip Shape Definition
+export type CircleClipShape = TLShape<typeof CIRCLE_CLIP_TYPE>
 
 export const isClippingEnabled$ = atom('isClippingEnabled', true)
 
 export class CircleClipShapeUtil extends BaseBoxShapeUtil<CircleClipShape> {
-	static override type = 'circle-clip' as const
+	static override type = CIRCLE_CLIP_TYPE
 	static override props: RecordProps<CircleClipShape> = {
 		w: T.number,
 		h: T.number,
@@ -113,8 +114,8 @@ export class CircleClipShapeTool extends StateNode {
 		if (info.target === 'canvas') {
 			const { originPagePoint } = this.editor.inputs
 
-			this.editor.createShape<CircleClipShape>({
-				type: 'circle-clip',
+			this.editor.createShape({
+				type: CIRCLE_CLIP_TYPE,
 				x: originPagePoint.x - 100,
 				y: originPagePoint.y - 100,
 				props: {
@@ -153,9 +154,9 @@ beforeEach(() => {
 describe('CircleClipShapeUtil', () => {
 	describe('shape creation and properties', () => {
 		it('should create a circle clip shape with default properties', () => {
-			editor.createShape<CircleClipShape>({
+			editor.createShape({
 				id: ids.circleClip1,
-				type: 'circle-clip',
+				type: CIRCLE_CLIP_TYPE,
 				x: 100,
 				y: 100,
 				props: {
@@ -172,9 +173,9 @@ describe('CircleClipShapeUtil', () => {
 		})
 
 		it('should use default props when not specified', () => {
-			editor.createShape<CircleClipShape>({
+			editor.createShape({
 				id: ids.circleClip1,
-				type: 'circle-clip',
+				type: CIRCLE_CLIP_TYPE,
 				x: 100,
 				y: 100,
 				props: {},
@@ -188,9 +189,9 @@ describe('CircleClipShapeUtil', () => {
 
 	describe('geometry and clipping', () => {
 		it('should generate correct circle geometry', () => {
-			editor.createShape<CircleClipShape>({
+			editor.createShape({
 				id: ids.circleClip1,
-				type: 'circle-clip',
+				type: CIRCLE_CLIP_TYPE,
 				x: 100,
 				y: 100,
 				props: {
@@ -210,9 +211,9 @@ describe('CircleClipShapeUtil', () => {
 		})
 
 		it('should generate clip path for circle', () => {
-			editor.createShape<CircleClipShape>({
+			editor.createShape({
 				id: ids.circleClip1,
-				type: 'circle-clip',
+				type: CIRCLE_CLIP_TYPE,
 				x: 100,
 				y: 100,
 				props: {
@@ -245,9 +246,9 @@ describe('CircleClipShapeUtil', () => {
 
 	describe('child clipping behavior', () => {
 		it('should clip children when clipping is enabled', () => {
-			editor.createShape<CircleClipShape>({
+			editor.createShape({
 				id: ids.circleClip1,
-				type: 'circle-clip',
+				type: CIRCLE_CLIP_TYPE,
 				x: 100,
 				y: 100,
 				props: {
@@ -256,7 +257,7 @@ describe('CircleClipShapeUtil', () => {
 				},
 			})
 
-			editor.createShape<TLTextShape>({
+			editor.createShape({
 				id: ids.text1,
 				type: 'text',
 				x: 0,
@@ -279,9 +280,9 @@ describe('CircleClipShapeUtil', () => {
 		it('should not clip children when clipping is disabled', () => {
 			isClippingEnabled$.set(false)
 
-			editor.createShape<CircleClipShape>({
+			editor.createShape({
 				id: ids.circleClip1,
-				type: 'circle-clip',
+				type: CIRCLE_CLIP_TYPE,
 				x: 100,
 				y: 100,
 				props: {
@@ -290,7 +291,7 @@ describe('CircleClipShapeUtil', () => {
 				},
 			})
 
-			editor.createShape<TLTextShape>({
+			editor.createShape({
 				id: ids.text1,
 				type: 'text',
 				x: 0,
@@ -314,9 +315,9 @@ describe('CircleClipShapeUtil', () => {
 describe('Integration tests', () => {
 	it('should create and manage circle clip shapes with children', () => {
 		// Create circle clip shape
-		editor.createShape<CircleClipShape>({
+		editor.createShape({
 			id: ids.circleClip1,
-			type: 'circle-clip',
+			type: CIRCLE_CLIP_TYPE,
 			x: 100,
 			y: 100,
 			props: {
@@ -326,7 +327,7 @@ describe('Integration tests', () => {
 		})
 
 		// Add text child
-		editor.createShape<TLTextShape>({
+		editor.createShape({
 			id: ids.text1,
 			type: 'text',
 			x: 50,
@@ -338,7 +339,7 @@ describe('Integration tests', () => {
 		})
 
 		// Add geo child
-		editor.createShape<TLGeoShape>({
+		editor.createShape({
 			id: ids.geo1,
 			type: 'geo',
 			x: 150,
@@ -375,9 +376,9 @@ describe('Integration tests', () => {
 
 	it('should handle multiple circle clip shapes independently', () => {
 		// Create two circle clip shapes
-		editor.createShape<CircleClipShape>({
+		editor.createShape({
 			id: ids.circleClip1,
-			type: 'circle-clip',
+			type: CIRCLE_CLIP_TYPE,
 			x: 100,
 			y: 100,
 			props: {
@@ -386,9 +387,9 @@ describe('Integration tests', () => {
 			},
 		})
 
-		editor.createShape<CircleClipShape>({
+		editor.createShape({
 			id: ids.circleClip2,
-			type: 'circle-clip',
+			type: CIRCLE_CLIP_TYPE,
 			x: 400,
 			y: 100,
 			props: {
@@ -398,7 +399,7 @@ describe('Integration tests', () => {
 		})
 
 		// Add children to both
-		editor.createShape<TLTextShape>({
+		editor.createShape({
 			id: ids.text1,
 			type: 'text',
 			x: 0,
@@ -409,7 +410,7 @@ describe('Integration tests', () => {
 			},
 		})
 
-		editor.createShape<TLTextShape>({
+		editor.createShape({
 			id: ids.geo1,
 			type: 'text',
 			x: 0,

package/src/test/customSnapping.test.tsx

@@ -4,10 +4,10 @@ import {
 	Polyline2d,
 	ShapeUtil,
 	TLAnyShapeUtilConstructor,
-	TLBaseShape,
 	TLHandle,
 	TLHandleDragInfo,
 	TLLineShape,
+	TLShape,
 	TLShapeId,
 	Vec,
 	VecModel,
@@ -16,13 +16,19 @@ import {
 import { TestEditor } from './TestEditor'
 import { TL } from './test-jsx'
 
+const TEST1_TYPE = 'test1'
+
+declare module '@tldraw/tlschema' {
+	export interface TLGlobalShapePropsMap {
+		[TEST1_TYPE]: { w: number; h: number; boundsSnapPoints: VecModel[] | null }
+	}
+}
+
+type Test1Shape = TLShape<typeof TEST1_TYPE>
+
 describe('custom shape bounds snapping - translate', () => {
-	type TestShape = TLBaseShape<
-		'test',
-		{ w: number; h: number; boundsSnapPoints: VecModel[] | null }
-	>
-	class TestShapeUtil extends BaseBoxShapeUtil<TestShape> {
-		static override type = 'test'
+	class TestShapeUtil extends BaseBoxShapeUtil<Test1Shape> {
+		static override type = TEST1_TYPE
 		override getDefaultProps() {
 			return { w: 100, h: 100, boundsSnapPoints: null }
 		}
@@ -32,7 +38,7 @@ describe('custom shape bounds snapping - translate', () => {
 		override indicator() {
 			throw new Error('Method not implemented.')
 		}
-		override getBoundsSnapGeometry(shape: TestShape) {
+		override getBoundsSnapGeometry(shape: Test1Shape) {
 			return {
 				points: shape.props.boundsSnapPoints ?? undefined,
 			}
@@ -46,14 +52,14 @@ describe('custom shape bounds snapping - translate', () => {
 		editor = new TestEditor({ shapeUtils })
 		ids = editor.createShapesFromJsx([
 			<TL.geo ref="box" x={0} y={0} w={100} h={100} />,
-			<TL.test ref="test" x={200} y={200} w={100} h={100} boundsSnapPoints={null} />,
+			<TL.test1 ref="test1" x={200} y={200} w={100} h={100} boundsSnapPoints={null} />,
 		])
 	})
 
 	describe('with default boundSnapPoints', () => {
 		test('normal snapping works with default boundSnapPoints when moving test shape', () => {
 			// start translating the test shape
-			editor.setSelectedShapes([ids.test]).pointerDown(250, 250)
+			editor.setSelectedShapes([ids.test1]).pointerDown(250, 250)
 
 			// move the left edge of the test shape to the right edge of the box shape - it should snap
 			editor.pointerMove(155, 250, undefined, { ctrlKey: true })
@@ -84,15 +90,15 @@ describe('custom shape bounds snapping - translate', () => {
 
 	describe('with only the center in boundSnapPoints', () => {
 		beforeEach(() => {
-			editor.updateShape<TestShape>({
-				id: ids.test,
-				type: 'test',
+			editor.updateShape({
+				id: ids.test1,
+				type: TEST1_TYPE,
 				props: { boundsSnapPoints: [{ x: 50, y: 50 }] },
 			})
 		})
 
 		describe('when moving the test shape', () => {
-			beforeEach(() => editor.select(ids.test).pointerDown(250, 250))
+			beforeEach(() => editor.select(ids.test1).pointerDown(250, 250))
 
 			test('does not snap its edges to the box edges', () => {
 				editor.pointerMove(155, 250, undefined, { ctrlKey: true })
@@ -126,15 +132,15 @@ describe('custom shape bounds snapping - translate', () => {
 
 	describe('with empty boundSnapPoints', () => {
 		beforeEach(() => {
-			editor.updateShape<TestShape>({
-				id: ids.test,
-				type: 'test',
+			editor.updateShape({
+				id: ids.test1,
+				type: TEST1_TYPE,
 				props: { boundsSnapPoints: [] },
 			})
 		})
 
 		test('test shape does not snap to anything', () => {
-			editor.select(ids.test).pointerDown(250, 250)
+			editor.select(ids.test1).pointerDown(250, 250)
 
 			// try to snap our left edge to the right edge of the box shape - it should not snap
 			editor.pointerMove(155, 250, undefined, { ctrlKey: true })
@@ -163,10 +169,11 @@ describe('custom shape bounds snapping - translate', () => {
 	})
 })
 
-describe('custom handle snapping', () => {
-	type TestShape = TLBaseShape<
-		'test',
-		{
+const TEST2_TYPE = 'test2'
+
+declare module '@tldraw/tlschema' {
+	export interface TLGlobalShapePropsMap {
+		[TEST2_TYPE]: {
 			w: number
 			h: number
 			ownHandle: VecModel
@@ -176,10 +183,15 @@ describe('custom handle snapping', () => {
 			selfSnapPoints: VecModel[] | 'default'
 			handleSnapType?: 'point' | 'align'
 		}
-	>
-	class TestShapeUtil extends BaseBoxShapeUtil<TestShape> {
-		static override type = 'test'
-		override getDefaultProps(): TestShape['props'] {
+	}
+}
+
+type Test2Shape = TLShape<typeof TEST2_TYPE>
+
+describe('custom handle snapping', () => {
+	class TestShapeUtil extends BaseBoxShapeUtil<Test2Shape> {
+		static override type = TEST2_TYPE
+		override getDefaultProps(): Test2Shape['props'] {
 			return {
 				w: 100,
 				h: 100,
@@ -196,7 +208,7 @@ describe('custom handle snapping', () => {
 		override indicator() {
 			throw new Error('Method not implemented.')
 		}
-		override getHandleSnapGeometry(shape: TestShape) {
+		override getHandleSnapGeometry(shape: Test2Shape) {
 			const { handleOutline, handlePoints, selfSnapOutline, selfSnapPoints } = shape.props
 			return {
 				outline:
@@ -214,7 +226,7 @@ describe('custom handle snapping', () => {
 				getSelfSnapPoints: selfSnapPoints === 'default' ? undefined : () => selfSnapPoints,
 			}
 		}
-		override getHandles(shape: TestShape): TLHandle[] {
+		override getHandles(shape: Test2Shape): TLHandle[] {
 			const handle: TLHandle = {
 				id: 'handle',
 				label: 'handle',
@@ -233,7 +245,7 @@ describe('custom handle snapping', () => {
 
 			return [handle]
 		}
-		override onHandleDrag(shape: TestShape, { handle }: TLHandleDragInfo<TestShape>) {
+		override onHandleDrag(shape: Test2Shape, { handle }: TLHandleDragInfo<Test2Shape>) {
 			return { ...shape, props: { ...shape.props, ownHandle: { x: handle.x, y: handle.y } } }
 		}
 	}
@@ -253,7 +265,7 @@ describe('custom handle snapping', () => {
 					a2: { id: 'a2', index: 'a2' as IndexKey, x: 100, y: 100 },
 				}}
 			/>,
-			<TL.test ref="test" x={200} y={200} w={100} h={100} boundsSnapPoints={null} />,
+			<TL.test2 ref="test2" x={200} y={200} w={100} h={100} />,
 		])
 	})
 
@@ -296,9 +308,9 @@ describe('custom handle snapping', () => {
 
 	describe('with empty handleSnapGeometry.outline', () => {
 		beforeEach(() => {
-			editor.updateShape<TestShape>({
-				id: ids.test,
-				type: 'test',
+			editor.updateShape({
+				id: ids.test2,
+				type: TEST2_TYPE,
 				props: { handleOutline: null },
 			})
 		})
@@ -313,9 +325,9 @@ describe('custom handle snapping', () => {
 
 	describe('with custom handleSnapGeometry.outline', () => {
 		beforeEach(() => {
-			editor.updateShape<TestShape>({
-				id: ids.test,
-				type: 'test',
+			editor.updateShape({
+				id: ids.test2,
+				type: TEST2_TYPE,
 				props: {
 					// a diagonal line from the top left to the bottom right
 					handleOutline: [
@@ -360,9 +372,9 @@ describe('custom handle snapping', () => {
 
 	describe('with custom handleSnapGeometry.points', () => {
 		beforeEach(() => {
-			editor.updateShape<TestShape>({
-				id: ids.test,
-				type: 'test',
+			editor.updateShape({
+				id: ids.test2,
+				type: TEST2_TYPE,
 				props: {
 					handlePoints: [
 						{ x: 30, y: 30 },
@@ -387,12 +399,12 @@ describe('custom handle snapping', () => {
 
 	describe('with custom handleSnapGeometry.points along the outline', () => {
 		beforeEach(() => {
-			editor.updateShape<TestShape>({
-				id: ids.test,
-				type: 'test',
+			editor.updateShape({
+				id: ids.test2,
+				type: TEST2_TYPE,
 				props: {
 					handlePoints: editor
-						.getShapeGeometry(ids.test)
+						.getShapeGeometry(ids.test2)
 						.bounds.cornersAndCenter.map(({ x, y }) => ({ x, y })),
 				},
 			})
@@ -426,9 +438,9 @@ describe('custom handle snapping', () => {
 	describe('self snapping', () => {
 		beforeEach(() => {
 			editor.deleteShape(ids.line)
-			editor.updateShape<TestShape>({
-				id: ids.test,
-				type: 'test',
+			editor.updateShape({
+				id: ids.test2,
+				type: TEST2_TYPE,
 				x: 0,
 				y: 0,
 				props: {
@@ -437,12 +449,12 @@ describe('custom handle snapping', () => {
 			})
 		})
 		function startDraggingOwnHandle() {
-			const shape = editor.select(ids.test).getOnlySelectedShape()!
+			const shape = editor.select(ids.test2).getOnlySelectedShape()!
 			const handles = editor.getShapeHandles(shape)!
 			editor.pointerDown(0, 0, { target: 'handle', shape, handle: handles[0] })
 		}
 		function ownHandlePosition() {
-			const shape = editor.select(ids.test).getOnlySelectedShape()!
+			const shape = editor.select(ids.test2).getOnlySelectedShape()!
 			const handle = editor.getShapeHandles(shape)![0]
 			return { x: handle.x, y: handle.y }
 		}
@@ -462,9 +474,9 @@ describe('custom handle snapping', () => {
 		})
 		describe('with custom self snap outline & points', () => {
 			beforeEach(() => {
-				editor.updateShape<TestShape>({
-					id: ids.test,
-					type: 'test',
+				editor.updateShape({
+					id: ids.test2,
+					type: TEST2_TYPE,
 					props: {
 						selfSnapOutline: [
 							{ x: 20, y: 50 },
@@ -506,9 +518,9 @@ describe('custom handle snapping', () => {
 
 		describe('with snapType set to align', () => {
 			beforeEach(() => {
-				editor.updateShape<TestShape>({
-					id: ids.test,
-					type: 'test',
+				editor.updateShape({
+					id: ids.test2,
+					type: TEST2_TYPE,
 					props: {
 						selfSnapPoints: [
 							{ x: 20, y: 50 },
@@ -543,19 +555,24 @@ describe('custom handle snapping', () => {
 	})
 })
 
-describe('custom adjacent handle for shift snapping', () => {
-	type BezierShape = TLBaseShape<
-		'bezier',
-		{
+const BEZIER_TYPE = 'bezier'
+
+declare module '@tldraw/tlschema' {
+	export interface TLGlobalShapePropsMap {
+		[BEZIER_TYPE]: {
 			start: VecModel
 			cp1: VecModel
 			cp2: VecModel
 			end: VecModel
 		}
-	>
+	}
+}
+
+type BezierShape = TLShape<typeof BEZIER_TYPE>
 
+describe('custom adjacent handle for shift snapping', () => {
 	class BezierShapeUtil extends ShapeUtil<BezierShape> {
-		static override type = 'bezier'
+		static override type = BEZIER_TYPE
 		override getDefaultProps() {
 			return {
 				start: { x: 0, y: 0 },
@@ -632,8 +649,6 @@ describe('custom adjacent handle for shift snapping', () => {
 				ref="bezier"
 				x={0}
 				y={0}
-				w={100}
-				h={100}
 				start={{ x: 0, y: 0 }}
 				cp1={{ x: 50, y: 0 }}
 				cp2={{ x: 50, y: 100 }}

package/src/test/duplicate.test.ts

@@ -295,7 +295,7 @@ describe('When duplicating shapes that include arrows', () => {
 			.select(
 				...editor
 					.getCurrentPageShapes()
-					.filter((s) => editor.isShapeOfType<TLArrowShape>(s, 'arrow'))
+					.filter((s) => editor.isShapeOfType(s, 'arrow'))
 					.map((s) => s.id)
 			)
 

package/src/test/frames.test.ts

@@ -1363,13 +1363,13 @@ describe('Unparenting behavior', () => {
 
 		// When the shape has a fill, it should not fall out of the frame
 		editor.undo()
-		editor.updateShape<TLGeoShape>({ ...largeRect, props: { fill: 'solid' } })
+		editor.updateShape({ ...largeRect, props: { fill: 'solid' } })
 		dragOntoFrame()
 		expect(editor.getShape(largeRect.id)!.parentId).toBe(frameId)
 
 		// When the shape has a label and that label is on top of the frame, it should not fall out of the frame
 		editor.undo()
-		editor.updateShape<TLGeoShape>({
+		editor.updateShape({
 			...largeRect,
 			props: { fill: 'none', richText: toRichText('hello') },
 		})

package/src/test/getCulledShapes.test.tsx

@@ -3,7 +3,7 @@ import {
 	Box,
 	RecordProps,
 	T,
-	TLBaseShape,
+	TLShape,
 	TLShapeId,
 	createShapeId,
 } from '@tldraw/editor'
@@ -11,11 +11,19 @@ import { vi } from 'vitest'
 import { TestEditor } from './TestEditor'
 import { TL } from './test-jsx'
 
+const UNCULLABLE_TYPE = 'uncullable'
+
+declare module '@tldraw/tlschema' {
+	export interface TLGlobalShapePropsMap {
+		[UNCULLABLE_TYPE]: { w: number; h: number }
+	}
+}
+
 // Custom uncullable shape type for testing canCull override
-type UncullableShape = TLBaseShape<'uncullable', { w: number; h: number }>
+type UncullableShape = TLShape<typeof UNCULLABLE_TYPE>
 
 class UncullableShapeUtil extends BaseBoxShapeUtil<UncullableShape> {
-	static override type = 'uncullable' as const
+	static override type = UNCULLABLE_TYPE
 	static override props: RecordProps<UncullableShape> = {
 		w: T.number,
 		h: T.number,

package/src/test/getShapeAtPoint.test.ts

@@ -1,4 +1,4 @@
-import { TLGeoShape, TLShape, createShapeId, toRichText } from '@tldraw/editor'
+import { TLShape, createShapeId, toRichText } from '@tldraw/editor'
 import { TestEditor } from './TestEditor'
 
 let editor: TestEditor
@@ -146,7 +146,7 @@ describe('with hitLabels=true', () => {
 	it('hits geo shape label behind overlapping hollow shape', () => {
 		// label is empty
 		expect(editor.getShapeAtPoint({ x: 350, y: 350 }, opts)?.id).toBe(ids.box3)
-		editor.updateShape<TLGeoShape>({
+		editor.updateShape({
 			id: ids.box2,
 			type: 'geo',
 			props: { richText: toRichText('hello') },

package/src/test/groups.test.tsx

@@ -1,5 +1,6 @@
 import {
 	Box,
+	ExtractShapeByProps,
 	GroupShapeUtil,
 	TLArrowShape,
 	TLGroupShape,
@@ -35,14 +36,16 @@ const ids = {
 	groupA: createShapeId('groupA'),
 }
 
+type BoxShape = ExtractShapeByProps<{ fill: string }>
+
 const box = (
 	id: TLShapeId,
 	x: number,
 	y: number,
 	w = 10,
 	h = 10,
-	fill = 'solid'
-): TLShapePartial => ({
+	fill: BoxShape['props']['fill'] = 'solid'
+): TLShapePartial<BoxShape> => ({
 	type: 'geo',
 	id,
 	x,
@@ -1980,7 +1983,7 @@ describe('Group opacity', () => {
 		editor.setOpacityForNextShapes(0.5)
 		editor.groupShapes(editor.getSelectedShapeIds())
 		const group = editor.getShape(onlySelectedId())!
-		assert(editor.isShapeOfType<TLGroupShape>(group, 'group'))
+		assert(editor.isShapeOfType(group, 'group'))
 		expect(group.opacity).toBe(1)
 	})
 })