@tldraw/tlschema 4.2.1 → 4.2.2

package/src/records/TLPageState.test.ts

@@ -1,228 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import {
-	instancePageStateMigrations,
-	InstancePageStateRecordType,
-	instancePageStateValidator,
-	instancePageStateVersions,
-	TLInstancePageStateId,
-} from './TLPageState'
-
-describe('instancePageStateValidator', () => {
-	it('should reject invalid typeName', () => {
-		const invalidPageState = {
-			typeName: 'not-instance-page-state',
-			id: 'instance_page_state:test' as TLInstancePageStateId,
-			pageId: 'page:test' as any,
-			selectedShapeIds: [],
-			hintingShapeIds: [],
-			erasingShapeIds: [],
-			hoveredShapeId: null,
-			editingShapeId: null,
-			croppingShapeId: null,
-			focusedGroupId: null,
-			meta: {},
-		}
-
-		expect(() => instancePageStateValidator.validate(invalidPageState)).toThrow()
-	})
-
-	it('should reject invalid id format', () => {
-		const invalidPageState = {
-			typeName: 'instance_page_state',
-			id: 'not-valid-id' as TLInstancePageStateId,
-			pageId: 'page:test' as any,
-			selectedShapeIds: [],
-			hintingShapeIds: [],
-			erasingShapeIds: [],
-			hoveredShapeId: null,
-			editingShapeId: null,
-			croppingShapeId: null,
-			focusedGroupId: null,
-			meta: {},
-		}
-
-		expect(() => instancePageStateValidator.validate(invalidPageState)).toThrow()
-	})
-
-	it('should reject missing required fields', () => {
-		const incompletePageState = {
-			typeName: 'instance_page_state',
-			id: 'instance_page_state:test' as TLInstancePageStateId,
-			pageId: 'page:test' as any,
-			// missing required array fields
-		}
-
-		expect(() => instancePageStateValidator.validate(incompletePageState)).toThrow()
-	})
-})
-
-describe('instancePageStateMigrations', () => {
-	it('should migrate AddCroppingId correctly', () => {
-		const migration = instancePageStateMigrations.sequence.find(
-			(m) => m.id === instancePageStateVersions.AddCroppingId
-		)!
-		const oldRecord: any = { id: 'instance_page_state:test', typeName: 'instance_page_state' }
-		migration.up(oldRecord)
-
-		expect(oldRecord.croppingShapeId).toBe(null)
-	})
-
-	it('should migrate RemoveInstanceIdAndCameraId correctly', () => {
-		const migration = instancePageStateMigrations.sequence.find(
-			(m) => m.id === instancePageStateVersions.RemoveInstanceIdAndCameraId
-		)!
-		const oldRecord: any = {
-			id: 'instance_page_state:test',
-			typeName: 'instance_page_state',
-			instanceId: 'instance:removed',
-			cameraId: 'camera:removed',
-			otherProp: 'keep-me',
-		}
-		migration.up(oldRecord)
-
-		expect(oldRecord.instanceId).toBeUndefined()
-		expect(oldRecord.cameraId).toBeUndefined()
-		expect(oldRecord.otherProp).toBe('keep-me')
-	})
-
-	it('should migrate AddMeta correctly', () => {
-		const migration = instancePageStateMigrations.sequence.find(
-			(m) => m.id === instancePageStateVersions.AddMeta
-		)!
-		const oldRecord: any = { id: 'instance_page_state:test', typeName: 'instance_page_state' }
-		migration.up(oldRecord)
-
-		expect(oldRecord.meta).toEqual({})
-	})
-
-	it('should handle RenameProperties migration (noop)', () => {
-		const migration = instancePageStateMigrations.sequence.find(
-			(m) => m.id === instancePageStateVersions.RenameProperties
-		)!
-		const oldRecord: any = {
-			id: 'instance_page_state:test',
-			typeName: 'instance_page_state',
-			selectedIds: ['shape:1'],
-		}
-		const originalRecord = { ...oldRecord }
-		migration.up(oldRecord)
-
-		// Should be a noop
-		expect(oldRecord).toEqual(originalRecord)
-	})
-
-	it('should migrate RenamePropertiesAgain correctly', () => {
-		const migration = instancePageStateMigrations.sequence.find(
-			(m) => m.id === instancePageStateVersions.RenamePropertiesAgain
-		)!
-		const oldRecord: any = {
-			id: 'instance_page_state:test',
-			typeName: 'instance_page_state',
-			selectedIds: ['shape:1', 'shape:2'],
-			hintingIds: ['shape:3'],
-			erasingIds: ['shape:4'],
-			hoveredId: 'shape:5',
-			editingId: 'shape:6',
-			croppingId: 'shape:7',
-			focusLayerId: 'shape:8',
-		}
-		migration.up(oldRecord)
-
-		expect(oldRecord.selectedShapeIds).toEqual(['shape:1', 'shape:2'])
-		expect(oldRecord.hintingShapeIds).toEqual(['shape:3'])
-		expect(oldRecord.erasingShapeIds).toEqual(['shape:4'])
-		expect(oldRecord.hoveredShapeId).toBe('shape:5')
-		expect(oldRecord.editingShapeId).toBe('shape:6')
-		expect(oldRecord.croppingShapeId).toBe('shape:7')
-		expect(oldRecord.focusedGroupId).toBe('shape:8')
-
-		// Old properties should be removed
-		expect(oldRecord.selectedIds).toBeUndefined()
-		expect(oldRecord.hintingIds).toBeUndefined()
-		expect(oldRecord.erasingIds).toBeUndefined()
-		expect(oldRecord.hoveredId).toBeUndefined()
-		expect(oldRecord.editingId).toBeUndefined()
-		expect(oldRecord.croppingId).toBeUndefined()
-		expect(oldRecord.focusLayerId).toBeUndefined()
-	})
-
-	it('should handle down migration for RenamePropertiesAgain', () => {
-		const migration = instancePageStateMigrations.sequence.find(
-			(m) => m.id === instancePageStateVersions.RenamePropertiesAgain
-		)!
-		expect(migration.down).toBeDefined()
-
-		const record: any = {
-			id: 'instance_page_state:test',
-			typeName: 'instance_page_state',
-			selectedShapeIds: ['shape:1', 'shape:2'],
-			hintingShapeIds: ['shape:3'],
-			erasingShapeIds: ['shape:4'],
-			hoveredShapeId: 'shape:5',
-			editingShapeId: 'shape:6',
-			croppingShapeId: 'shape:7',
-			focusedGroupId: 'shape:8',
-		}
-		migration.down!(record)
-
-		expect(record.selectedIds).toEqual(['shape:1', 'shape:2'])
-		expect(record.hintingIds).toEqual(['shape:3'])
-		expect(record.erasingIds).toEqual(['shape:4'])
-		expect(record.hoveredId).toBe('shape:5')
-		expect(record.editingId).toBe('shape:6')
-		expect(record.croppingId).toBe('shape:7')
-		expect(record.focusLayerId).toBe('shape:8')
-
-		// New properties should be removed
-		expect(record.selectedShapeIds).toBeUndefined()
-		expect(record.hintingShapeIds).toBeUndefined()
-		expect(record.erasingShapeIds).toBeUndefined()
-		expect(record.hoveredShapeId).toBeUndefined()
-		expect(record.editingShapeId).toBeUndefined()
-		expect(record.croppingShapeId).toBeUndefined()
-		expect(record.focusedGroupId).toBeUndefined()
-	})
-
-	it('should handle croppingShapeId fallback in RenamePropertiesAgain', () => {
-		const migration = instancePageStateMigrations.sequence.find(
-			(m) => m.id === instancePageStateVersions.RenamePropertiesAgain
-		)!
-
-		// Test with existing croppingShapeId
-		const recordWithCroppingShapeId: any = {
-			croppingShapeId: 'shape:existing',
-			croppingId: 'shape:fallback',
-		}
-		migration.up(recordWithCroppingShapeId)
-		expect(recordWithCroppingShapeId.croppingShapeId).toBe('shape:existing')
-
-		// Test with only croppingId
-		const recordWithCroppingId: any = {
-			croppingId: 'shape:fallback',
-		}
-		migration.up(recordWithCroppingId)
-		expect(recordWithCroppingId.croppingShapeId).toBe('shape:fallback')
-
-		// Test with neither
-		const recordWithNeither: any = {}
-		migration.up(recordWithNeither)
-		expect(recordWithNeither.croppingShapeId).toBe(null)
-	})
-})
-
-describe('InstancePageStateRecordType', () => {
-	it('should have correct ephemeral keys configuration', () => {
-		// Non-ephemeral keys (persistent)
-		expect(InstancePageStateRecordType.ephemeralKeys?.pageId).toBe(false)
-		expect(InstancePageStateRecordType.ephemeralKeys?.selectedShapeIds).toBe(false)
-		expect(InstancePageStateRecordType.ephemeralKeys?.editingShapeId).toBe(false)
-		expect(InstancePageStateRecordType.ephemeralKeys?.croppingShapeId).toBe(false)
-		expect(InstancePageStateRecordType.ephemeralKeys?.meta).toBe(false)
-
-		// Ephemeral keys (temporary)
-		expect(InstancePageStateRecordType.ephemeralKeys?.hintingShapeIds).toBe(true)
-		expect(InstancePageStateRecordType.ephemeralKeys?.erasingShapeIds).toBe(true)
-		expect(InstancePageStateRecordType.ephemeralKeys?.hoveredShapeId).toBe(true)
-		expect(InstancePageStateRecordType.ephemeralKeys?.focusedGroupId).toBe(true)
-	})
-})

package/src/records/TLPointer.test.ts

@@ -1,63 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { pointerMigrations, pointerValidator, pointerVersions, TLPOINTER_ID } from './TLPointer'
-
-describe('pointerValidator', () => {
-	it('should validate valid pointer records', () => {
-		const validPointer = {
-			typeName: 'pointer',
-			id: TLPOINTER_ID,
-			x: 100,
-			y: 200,
-			lastActivityTimestamp: Date.now(),
-			meta: {},
-		}
-
-		expect(() => pointerValidator.validate(validPointer)).not.toThrow()
-	})
-
-	it('should reject pointers with invalid typeName', () => {
-		const invalidPointer = {
-			typeName: 'not-pointer',
-			id: TLPOINTER_ID,
-			x: 0,
-			y: 0,
-			lastActivityTimestamp: 0,
-			meta: {},
-		}
-
-		expect(() => pointerValidator.validate(invalidPointer)).toThrow()
-	})
-
-	it('should reject pointers with missing required fields', () => {
-		const incompletePointer = {
-			typeName: 'pointer',
-			id: TLPOINTER_ID,
-			x: 0,
-			// missing y, lastActivityTimestamp, meta
-		}
-
-		expect(() => pointerValidator.validate(incompletePointer)).toThrow()
-	})
-})
-
-describe('pointerMigrations', () => {
-	it('should apply AddMeta migration correctly', () => {
-		const addMetaMigration = pointerMigrations.sequence.find(
-			(m) => m.id === pointerVersions.AddMeta
-		)!
-
-		const oldRecord: any = {
-			typeName: 'pointer',
-			id: TLPOINTER_ID,
-			x: 100,
-			y: 200,
-			lastActivityTimestamp: 123456,
-		}
-
-		addMetaMigration.up(oldRecord)
-		expect(oldRecord.meta).toEqual({})
-		expect(oldRecord.x).toBe(100)
-		expect(oldRecord.y).toBe(200)
-		expect(oldRecord.lastActivityTimestamp).toBe(123456)
-	})
-})

package/src/records/TLPresence.test.ts

@@ -1,190 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import {
-	instancePresenceMigrations,
-	instancePresenceValidator,
-	instancePresenceVersions,
-	TLInstancePresenceID,
-} from './TLPresence'
-
-describe('instancePresenceValidator', () => {
-	it('should validate valid instance presence records', () => {
-		const validPresence = {
-			typeName: 'instance_presence',
-			id: 'instance_presence:test' as TLInstancePresenceID,
-			userId: 'user123',
-			userName: 'Test User',
-			lastActivityTimestamp: null,
-			color: '#007AFF',
-			camera: null,
-			selectedShapeIds: [],
-			currentPageId: 'page:main' as any,
-			brush: null,
-			scribbles: [],
-			screenBounds: null,
-			followingUserId: null,
-			cursor: null,
-			chatMessage: '',
-			meta: {},
-		}
-
-		expect(() => instancePresenceValidator.validate(validPresence)).not.toThrow()
-		const validated = instancePresenceValidator.validate(validPresence)
-		expect(validated).toEqual(validPresence)
-	})
-
-	it('should validate presence with complete data', () => {
-		const complexPresence = {
-			typeName: 'instance_presence',
-			id: 'instance_presence:complex' as TLInstancePresenceID,
-			userId: 'user456',
-			userName: 'Complex User',
-			lastActivityTimestamp: Date.now(),
-			color: '#FF3B30',
-			camera: { x: -100, y: 200, z: 0.75 },
-			selectedShapeIds: ['shape:1' as any, 'shape:2' as any],
-			currentPageId: 'page:design' as any,
-			brush: { x: 50, y: 75, w: 150, h: 100 },
-			scribbles: [
-				{
-					id: 'scribble:1',
-					points: [{ x: 0, y: 0, z: 0.5 }],
-					size: 4,
-					color: 'black',
-					opacity: 1,
-					state: 'starting',
-					delay: 0,
-					shrink: 0,
-					taper: false,
-				},
-			],
-			screenBounds: { x: 0, y: 0, w: 2560, h: 1440 },
-			followingUserId: 'leader123',
-			cursor: { x: 300, y: 400, type: 'pointer', rotation: 45 },
-			chatMessage: 'Working on design!',
-			meta: { team: 'design', role: 'designer' },
-		}
-
-		expect(() => instancePresenceValidator.validate(complexPresence)).not.toThrow()
-	})
-
-	it('should reject invalid typeName', () => {
-		const invalidPresence = {
-			typeName: 'not-instance-presence',
-			id: 'instance_presence:test' as TLInstancePresenceID,
-			userId: 'user123',
-			userName: 'Test',
-			lastActivityTimestamp: null,
-			color: '#000000',
-			camera: null,
-			selectedShapeIds: [],
-			currentPageId: 'page:main' as any,
-			brush: null,
-			scribbles: [],
-			screenBounds: null,
-			followingUserId: null,
-			cursor: null,
-			chatMessage: '',
-			meta: {},
-		}
-
-		expect(() => instancePresenceValidator.validate(invalidPresence)).toThrow()
-	})
-})
-
-describe('instancePresenceMigrations', () => {
-	it('should migrate AddScribbleDelay correctly', () => {
-		const migration = instancePresenceMigrations.sequence.find(
-			(m) => m.id === instancePresenceVersions.AddScribbleDelay
-		)!
-
-		const oldRecordWithScribble: any = {
-			scribble: { points: [], size: 4, color: 'black' },
-		}
-		migration.up(oldRecordWithScribble)
-		expect(oldRecordWithScribble.scribble.delay).toBe(0)
-
-		const oldRecordWithoutScribble: any = {
-			scribble: null,
-		}
-		migration.up(oldRecordWithoutScribble)
-		expect(oldRecordWithoutScribble.scribble).toBe(null)
-	})
-
-	it('should migrate RemoveInstanceId correctly', () => {
-		const migration = instancePresenceMigrations.sequence.find(
-			(m) => m.id === instancePresenceVersions.RemoveInstanceId
-		)!
-		const oldRecord: any = {
-			instanceId: 'instance:removed',
-			otherProp: 'keep-me',
-		}
-		migration.up(oldRecord)
-
-		expect(oldRecord.instanceId).toBeUndefined()
-		expect(oldRecord.otherProp).toBe('keep-me')
-	})
-
-	it('should migrate AddChatMessage correctly', () => {
-		const migration = instancePresenceMigrations.sequence.find(
-			(m) => m.id === instancePresenceVersions.AddChatMessage
-		)!
-		const oldRecord: any = { id: 'instance_presence:test' }
-		migration.up(oldRecord)
-
-		expect(oldRecord.chatMessage).toBe('')
-	})
-
-	it('should migrate AddMeta correctly', () => {
-		const migration = instancePresenceMigrations.sequence.find(
-			(m) => m.id === instancePresenceVersions.AddMeta
-		)!
-		const oldRecord: any = { id: 'instance_presence:test' }
-		migration.up(oldRecord)
-
-		expect(oldRecord.meta).toEqual({})
-	})
-
-	it('should handle RenameSelectedShapeIds migration (noop)', () => {
-		const migration = instancePresenceMigrations.sequence.find(
-			(m) => m.id === instancePresenceVersions.RenameSelectedShapeIds
-		)!
-		const oldRecord: any = { selectedShapeIds: ['shape:1'] }
-		const originalRecord = { ...oldRecord }
-		migration.up(oldRecord)
-
-		// Should be a noop
-		expect(oldRecord).toEqual(originalRecord)
-	})
-
-	it('should handle NullableCameraCursor migration up (noop)', () => {
-		const migration = instancePresenceMigrations.sequence.find(
-			(m) => m.id === instancePresenceVersions.NullableCameraCursor
-		)!
-		const record: any = { camera: null, cursor: null }
-		const originalRecord = { ...record }
-		migration.up(record)
-
-		// Should be a noop
-		expect(record).toEqual(originalRecord)
-	})
-
-	it('should handle NullableCameraCursor migration down', () => {
-		const migration = instancePresenceMigrations.sequence.find(
-			(m) => m.id === instancePresenceVersions.NullableCameraCursor
-		)!
-		expect(migration.down).toBeDefined()
-
-		const record: any = {
-			camera: null,
-			lastActivityTimestamp: null,
-			cursor: null,
-			screenBounds: null,
-		}
-		migration.down!(record)
-
-		expect(record.camera).toEqual({ x: 0, y: 0, z: 1 })
-		expect(record.lastActivityTimestamp).toBe(0)
-		expect(record.cursor).toEqual({ type: 'default', x: 0, y: 0, rotation: 0 })
-		expect(record.screenBounds).toEqual({ x: 0, y: 0, w: 1, h: 1 })
-	})
-})

package/src/records/TLRecord.test.ts

@@ -1,70 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { TLRecord } from './TLRecord'
-
-describe('TLRecord', () => {
-	it('should support type discrimination by typeName', () => {
-		function processRecord(record: TLRecord): string {
-			// TypeScript should be able to narrow types based on typeName
-			switch (record.typeName) {
-				case 'shape':
-					return `Shape at (${record.x}, ${record.y})`
-				case 'page':
-					return `Page: ${record.name}`
-				case 'asset':
-					return `Asset: ${record.type}`
-				case 'binding':
-					return `Binding from ${record.fromId} to ${record.toId}`
-				case 'camera':
-					return `Camera at (${record.x}, ${record.y}) zoom: ${record.z}`
-				case 'document':
-					return `Document: ${record.name}, grid: ${record.gridSize}`
-				case 'instance':
-					return `Instance on page ${record.currentPageId}`
-				case 'instance_page_state':
-					return `Page state for ${record.pageId}`
-				case 'instance_presence':
-					return `Presence of ${record.userName}`
-				case 'pointer':
-					return `Pointer at (${record.x}, ${record.y})`
-				default:
-					// This should never be reached if all cases are handled
-					return 'Unknown record type'
-			}
-		}
-
-		// Test that the discriminated union works correctly
-		const shapeRecord: TLRecord = {
-			id: 'shape:test' as any,
-			typeName: 'shape',
-			type: 'geo',
-			x: 50,
-			y: 100,
-			rotation: 0,
-			index: 'a1' as any,
-			parentId: 'page:main' as any,
-			isLocked: false,
-			opacity: 1,
-			props: {
-				geo: 'rectangle',
-				w: 80,
-				h: 80,
-				color: 'black',
-				fill: 'none',
-				dash: 'draw',
-				size: 'm',
-			},
-			meta: {},
-		}
-
-		const pageRecord: TLRecord = {
-			id: 'page:test' as any,
-			typeName: 'page',
-			name: 'Test Page',
-			index: 'a1' as any,
-			meta: {},
-		}
-
-		expect(processRecord(shapeRecord)).toBe('Shape at (50, 100)')
-		expect(processRecord(pageRecord)).toBe('Page: Test Page')
-	})
-})