@tldraw/tlschema 4.2.1 → 4.2.2

package/src/records/TLAsset.test.ts

@@ -1,234 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { getTestMigration } from '../__tests__/migrationTestUtils'
-import {
-	assetMigrations,
-	AssetRecordType,
-	assetValidator,
-	assetVersions,
-	TLAssetId,
-} from './TLAsset'
-
-describe('TLAsset', () => {
-	describe('assetValidator', () => {
-		it('should validate different asset types using discriminated union', () => {
-			const imageAsset = {
-				id: 'asset:test_image',
-				typeName: 'asset' as const,
-				type: 'image' as const,
-				props: {
-					w: 100,
-					h: 100,
-					name: 'test.jpg',
-					isAnimated: false,
-					mimeType: 'image/jpeg',
-					src: 'https://example.com/test.jpg',
-				},
-				meta: {},
-			}
-
-			const videoAsset = {
-				id: 'asset:test_video',
-				typeName: 'asset' as const,
-				type: 'video' as const,
-				props: {
-					w: 640,
-					h: 480,
-					name: 'test.mp4',
-					isAnimated: true,
-					mimeType: 'video/mp4',
-					src: 'https://example.com/test.mp4',
-				},
-				meta: {},
-			}
-
-			const bookmarkAsset = {
-				id: 'asset:test_bookmark',
-				typeName: 'asset' as const,
-				type: 'bookmark' as const,
-				props: {
-					title: 'Test Site',
-					description: 'A test bookmark',
-					image: 'https://example.com/image.png',
-					favicon: 'https://example.com/favicon.ico',
-					src: 'https://example.com',
-				},
-				meta: {},
-			}
-
-			expect(() => assetValidator.validate(imageAsset)).not.toThrow()
-			expect(() => assetValidator.validate(videoAsset)).not.toThrow()
-			expect(() => assetValidator.validate(bookmarkAsset)).not.toThrow()
-
-			expect(assetValidator.validate(imageAsset).type).toBe('image')
-			expect(assetValidator.validate(videoAsset).type).toBe('video')
-			expect(assetValidator.validate(bookmarkAsset).type).toBe('bookmark')
-		})
-
-		it('should reject invalid asset types', () => {
-			const invalidAsset = {
-				id: 'asset:invalid',
-				typeName: 'asset' as const,
-				type: 'invalid_type' as any,
-				props: {
-					w: 100,
-					h: 100,
-					name: 'test.jpg',
-				},
-				meta: {},
-			}
-
-			expect(() => assetValidator.validate(invalidAsset)).toThrow()
-		})
-
-		it('should require valid asset structure', () => {
-			// Wrong typeName
-			const wrongTypeName = {
-				id: 'asset:wrong_typename',
-				typeName: 'shape' as const,
-				type: 'image' as const,
-				props: {
-					w: 100,
-					h: 100,
-					name: 'test.jpg',
-					isAnimated: false,
-					mimeType: 'image/jpeg',
-					src: 'https://example.com/test.jpg',
-				},
-				meta: {},
-			}
-			expect(() => assetValidator.validate(wrongTypeName)).toThrow()
-
-			// Missing meta
-			const noMeta = {
-				id: 'asset:no_meta',
-				typeName: 'asset' as const,
-				type: 'image' as const,
-				props: {
-					w: 100,
-					h: 100,
-					name: 'test.jpg',
-					isAnimated: false,
-					mimeType: 'image/jpeg',
-					src: 'https://example.com/test.jpg',
-				},
-			}
-			expect(() => assetValidator.validate(noMeta)).toThrow()
-
-			// Wrong ID prefix
-			const wrongId = {
-				id: 'shape:wrong_prefix',
-				typeName: 'asset' as const,
-				type: 'image' as const,
-				props: {
-					w: 100,
-					h: 100,
-					name: 'test.jpg',
-					isAnimated: false,
-					mimeType: 'image/jpeg',
-					src: 'https://example.com/test.jpg',
-				},
-				meta: {},
-			}
-			expect(() => assetValidator.validate(wrongId)).toThrow()
-		})
-	})
-
-	describe('assetMigrations', () => {
-		it('should have correct migration structure', () => {
-			expect(assetMigrations.sequenceId).toBe('com.tldraw.asset')
-			expect(assetMigrations.sequence).toHaveLength(1)
-			expect(assetMigrations.sequence[0].id).toBe(assetVersions.AddMeta)
-		})
-	})
-
-	describe('AddMeta migration', () => {
-		const { up } = getTestMigration(assetVersions.AddMeta)
-
-		it('should add empty meta property', () => {
-			const assetWithoutMeta = {
-				id: 'asset:test',
-				typeName: 'asset',
-				type: 'image',
-				props: {
-					w: 100,
-					h: 100,
-					name: 'test.jpg',
-					isAnimated: false,
-					mimeType: 'image/jpeg',
-					src: 'https://example.com/test.jpg',
-				},
-			}
-
-			const result = up(assetWithoutMeta)
-			expect(result.meta).toEqual({})
-			expect(result.props).toEqual(assetWithoutMeta.props)
-		})
-
-		it('should overwrite existing meta property', () => {
-			const assetWithMeta = {
-				id: 'asset:test',
-				typeName: 'asset',
-				type: 'image',
-				props: {
-					w: 100,
-					h: 100,
-					name: 'test.jpg',
-					isAnimated: false,
-					mimeType: 'image/jpeg',
-					src: 'https://example.com/test.jpg',
-				},
-				meta: { existing: 'data' },
-			}
-
-			const result = up(assetWithMeta)
-			expect(result.meta).toEqual({}) // Migration always sets to empty object
-		})
-
-		it('should preserve other properties during migration', () => {
-			const assetWithExtraProps = {
-				id: 'asset:extra_props',
-				typeName: 'asset',
-				type: 'image',
-				props: {
-					w: 200,
-					h: 150,
-					name: 'extra.png',
-					isAnimated: false,
-					mimeType: 'image/png',
-					src: 'https://example.com/extra.png',
-				},
-				customProperty: 'should be preserved',
-			}
-
-			const result = up(assetWithExtraProps)
-			expect(result.meta).toEqual({})
-			expect(result.customProperty).toBe('should be preserved')
-		})
-	})
-
-	describe('AssetRecordType', () => {
-		it('should have correct configuration', () => {
-			expect(AssetRecordType.typeName).toBe('asset')
-			expect(AssetRecordType.scope).toBe('document')
-			expect(AssetRecordType.validator).toBe(assetValidator)
-		})
-
-		it('should create records with default meta property', () => {
-			const assetRecord = AssetRecordType.create({
-				id: 'asset:test' as TLAssetId,
-				type: 'image',
-				props: {
-					w: 100,
-					h: 100,
-					name: 'test.jpg',
-					isAnimated: false,
-					mimeType: 'image/jpeg',
-					src: 'https://example.com/test.jpg',
-				},
-			})
-
-			expect(assetRecord.meta).toEqual({})
-			expect(assetRecord.typeName).toBe('asset')
-		})
-	})
-})

package/src/records/TLBinding.test.ts

@@ -1,22 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { createBindingId, rootBindingMigrations } from './TLBinding'
-
-describe('TLBinding', () => {
-	describe('createBindingId function', () => {
-		it('should generate IDs starting with binding:', () => {
-			const id = createBindingId()
-			expect(id.startsWith('binding:')).toBe(true)
-		})
-
-		it('should use custom ID when provided', () => {
-			expect(createBindingId('test')).toBe('binding:test')
-		})
-	})
-
-	describe('rootBindingMigrations', () => {
-		it('should have correct structure', () => {
-			expect(rootBindingMigrations.sequenceId).toBe('com.tldraw.binding')
-			expect(Array.isArray(rootBindingMigrations.sequence)).toBe(true)
-		})
-	})
-})

package/src/records/TLCamera.test.ts

@@ -1,19 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { cameraMigrations, cameraVersions } from './TLCamera'
-
-describe('cameraMigrations', () => {
-	it('should apply AddMeta migration correctly', () => {
-		const addMetaMigration = cameraMigrations.sequence.find((m) => m.id === cameraVersions.AddMeta)!
-
-		const oldRecord: any = {
-			typeName: 'camera',
-			id: 'camera:test',
-			x: 100,
-			y: 200,
-			z: 0.5,
-		}
-
-		addMetaMigration.up(oldRecord)
-		expect(oldRecord.meta).toEqual({})
-	})
-})

package/src/records/TLDocument.test.ts

@@ -1,35 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { documentMigrations, documentVersions, TLDOCUMENT_ID } from './TLDocument'
-
-describe('documentMigrations', () => {
-	it('should apply AddName migration correctly', () => {
-		const addNameMigration = documentMigrations.sequence.find(
-			(m) => m.id === documentVersions.AddName
-		)!
-
-		const oldRecord: any = {
-			typeName: 'document',
-			id: TLDOCUMENT_ID,
-			gridSize: 10,
-		}
-
-		addNameMigration.up(oldRecord)
-		expect(oldRecord.name).toBe('')
-	})
-
-	it('should apply AddMeta migration correctly', () => {
-		const addMetaMigration = documentMigrations.sequence.find(
-			(m) => m.id === documentVersions.AddMeta
-		)!
-
-		const oldRecord: any = {
-			typeName: 'document',
-			id: TLDOCUMENT_ID,
-			gridSize: 10,
-			name: 'Test',
-		}
-
-		addMetaMigration.up(oldRecord)
-		expect(oldRecord.meta).toEqual({})
-	})
-})

package/src/records/TLInstance.test.ts

@@ -1,201 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import { StyleProp } from '../styles/StyleProp'
-import {
-	createInstanceRecordType,
-	instanceIdValidator,
-	instanceMigrations,
-	instanceVersions,
-	pluckPreservingValues,
-	shouldKeyBePreservedBetweenSessions,
-	TLInstance,
-	TLINSTANCE_ID,
-} from './TLInstance'
-
-// Mock style prop for testing
-const mockColorStyle = {
-	type: 'color',
-	defaultValue: 'black',
-	getDefaultValue: () => 'black',
-} as unknown as StyleProp<string>
-
-const mockStylesMap = new Map([['color', mockColorStyle]])
-createInstanceRecordType(mockStylesMap)
-
-describe('shouldKeyBePreservedBetweenSessions', () => {
-	it('should preserve user preferences', () => {
-		const userPreferences = [
-			'isFocusMode',
-			'isDebugMode',
-			'isToolLocked',
-			'exportBackground',
-			'isGridMode',
-			'isReadonly',
-		]
-
-		userPreferences.forEach((key) => {
-			expect(
-				shouldKeyBePreservedBetweenSessions[key as keyof typeof shouldKeyBePreservedBetweenSessions]
-			).toBe(true)
-		})
-	})
-
-	it('should not preserve temporary state', () => {
-		const temporaryState = [
-			'currentPageId',
-			'opacityForNextShape',
-			'stylesForNextShape',
-			'followingUserId',
-			'brush',
-			'cursor',
-			'scribbles',
-			'zoomBrush',
-			'chatMessage',
-			'isChatting',
-			'isPenMode',
-			'isHoveringCanvas',
-			'openMenus',
-			'isChangingStyle',
-			'duplicateProps',
-		]
-
-		temporaryState.forEach((key) => {
-			expect(
-				shouldKeyBePreservedBetweenSessions[key as keyof typeof shouldKeyBePreservedBetweenSessions]
-			).toBe(false)
-		})
-	})
-})
-
-describe('pluckPreservingValues', () => {
-	it('should return null for null or undefined input', () => {
-		expect(pluckPreservingValues(null)).toBe(null)
-		expect(pluckPreservingValues(undefined)).toBe(null)
-	})
-
-	it('should filter properties according to preservation rules', () => {
-		const fullInstance: TLInstance = {
-			id: TLINSTANCE_ID,
-			typeName: 'instance',
-			currentPageId: 'page:page1' as any,
-			opacityForNextShape: 0.5,
-			stylesForNextShape: {},
-			followingUserId: null,
-			highlightedUserIds: [],
-			brush: null,
-			cursor: { type: 'default', rotation: 0 },
-			scribbles: [],
-			isFocusMode: true,
-			isDebugMode: false,
-			isToolLocked: true,
-			exportBackground: true,
-			screenBounds: { x: 0, y: 0, w: 1920, h: 1080 },
-			insets: [false, false, false, false],
-			zoomBrush: null,
-			chatMessage: '',
-			isChatting: false,
-			isPenMode: false,
-			isGridMode: true,
-			isFocused: true,
-			devicePixelRatio: 2,
-			isCoarsePointer: false,
-			isHoveringCanvas: null,
-			openMenus: [],
-			isChangingStyle: false,
-			isReadonly: false,
-			meta: {},
-			duplicateProps: null,
-		}
-
-		const preserved = pluckPreservingValues(fullInstance)
-
-		// Should preserve user preferences
-		expect(preserved?.isFocusMode).toBe(true)
-		expect(preserved?.isDebugMode).toBe(false)
-		expect(preserved?.isToolLocked).toBe(true)
-		expect(preserved?.exportBackground).toBe(true)
-		expect(preserved?.isGridMode).toBe(true)
-
-		// Should not preserve temporary state
-		expect(preserved?.currentPageId).toBeUndefined()
-		expect(preserved?.opacityForNextShape).toBeUndefined()
-		expect(preserved?.brush).toBeUndefined()
-		expect(preserved?.cursor).toBeUndefined()
-		expect(preserved?.chatMessage).toBeUndefined()
-		expect(preserved?.openMenus).toBeUndefined()
-	})
-})
-
-describe('instanceIdValidator', () => {
-	it('should validate correct instance IDs and reject invalid ones', () => {
-		expect(() => instanceIdValidator.validate('instance:instance')).not.toThrow()
-		expect(() => instanceIdValidator.validate('instance:test')).not.toThrow()
-		expect(() => instanceIdValidator.validate(TLINSTANCE_ID)).not.toThrow()
-
-		expect(() => instanceIdValidator.validate('invalid')).toThrow()
-		expect(() => instanceIdValidator.validate('page:instance')).toThrow()
-		expect(() => instanceIdValidator.validate('')).toThrow()
-	})
-})
-
-describe('createInstanceRecordType', () => {
-	it('should create a valid record type with correct configuration', () => {
-		const recordType = createInstanceRecordType(mockStylesMap)
-		expect(recordType.typeName).toBe('instance')
-		expect(recordType.scope).toBe('session')
-	})
-})
-
-describe('instanceMigrations', () => {
-	it('should have correct migration configuration', () => {
-		expect(instanceMigrations.sequenceId).toBe('com.tldraw.instance')
-		expect(Array.isArray(instanceMigrations.sequence)).toBe(true)
-		expect(instanceMigrations.sequence.length).toBe(25)
-	})
-
-	it('should migrate HoistOpacity correctly', () => {
-		const migration = instanceMigrations.sequence.find(
-			(m) => m.id === instanceVersions.HoistOpacity
-		)!
-		const oldRecord: any = {
-			id: TLINSTANCE_ID,
-			typeName: 'instance',
-			propsForNextShape: {
-				opacity: '0.5',
-				color: 'red',
-			},
-		}
-		const result = migration.up(oldRecord)
-
-		expect((result as any).opacityForNextShape).toBe(0.5)
-		expect((result as any).propsForNextShape.opacity).toBeUndefined()
-		expect((result as any).propsForNextShape.color).toBe('red')
-	})
-
-	it('should migrate RemoveDialog correctly', () => {
-		const migration = instanceMigrations.sequence.find(
-			(m) => m.id === instanceVersions.RemoveDialog
-		)!
-		const oldRecord: any = {
-			id: TLINSTANCE_ID,
-			typeName: 'instance',
-			dialog: 'some-dialog',
-			otherProp: 'keep-me',
-		}
-		const result = migration.up(oldRecord)
-
-		expect((result as any).dialog).toBeUndefined()
-		expect((result as any).otherProp).toBe('keep-me')
-	})
-
-	it('should have bidirectional migrations where applicable', () => {
-		const addInsetMigration = instanceMigrations.sequence.find(
-			(m) => m.id === instanceVersions.AddInset
-		)!
-		expect(addInsetMigration.down).toBeDefined()
-
-		const removeCameraMigration = instanceMigrations.sequence.find(
-			(m) => m.id === instanceVersions.RemoveCanMoveCamera
-		)!
-		expect(removeCameraMigration.down).toBeDefined()
-	})
-})

package/src/records/TLPage.test.ts

@@ -1,110 +0,0 @@
-import { describe, expect, it } from 'vitest'
-import {
-	isPageId,
-	pageIdValidator,
-	pageMigrations,
-	PageRecordType,
-	pageValidator,
-	pageVersions,
-	TLPageId,
-} from './TLPage'
-
-describe('pageIdValidator', () => {
-	it('should validate correct page IDs', () => {
-		expect(() => pageIdValidator.validate('page:main')).not.toThrow()
-		expect(() => pageIdValidator.validate('page:page1')).not.toThrow()
-	})
-
-	it('should reject invalid page IDs', () => {
-		expect(() => pageIdValidator.validate('invalid')).toThrow()
-		expect(() => pageIdValidator.validate('shape:page1')).toThrow()
-		expect(() => pageIdValidator.validate('')).toThrow()
-	})
-})
-
-describe('pageValidator', () => {
-	it('should validate valid page records', () => {
-		const validPage = {
-			typeName: 'page',
-			id: 'page:test' as TLPageId,
-			name: 'Test Page',
-			index: 'a1' as any,
-			meta: {},
-		}
-
-		expect(() => pageValidator.validate(validPage)).not.toThrow()
-	})
-
-	it('should reject pages with invalid typeName', () => {
-		const invalidPage = {
-			typeName: 'not-page',
-			id: 'page:test' as TLPageId,
-			name: 'Test',
-			index: 'a1' as any,
-			meta: {},
-		}
-
-		expect(() => pageValidator.validate(invalidPage)).toThrow()
-	})
-
-	it('should reject pages with missing required fields', () => {
-		const incompletePages = [
-			{
-				typeName: 'page',
-				id: 'page:test' as TLPageId,
-				// missing name, index, meta
-			},
-			{
-				typeName: 'page',
-				id: 'page:test' as TLPageId,
-				name: 'Test',
-				// missing index, meta
-			},
-		]
-
-		incompletePages.forEach((page) => {
-			expect(() => pageValidator.validate(page)).toThrow()
-		})
-	})
-})
-
-describe('pageMigrations', () => {
-	it('should apply AddMeta migration correctly', () => {
-		const addMetaMigration = pageMigrations.sequence.find((m) => m.id === pageVersions.AddMeta)!
-
-		const oldRecord: any = {
-			typeName: 'page',
-			id: 'page:test',
-			name: 'Test Page',
-			index: 'a1',
-		}
-
-		addMetaMigration.up(oldRecord)
-		expect(oldRecord.meta).toEqual({})
-	})
-})
-
-describe('PageRecordType', () => {
-	it('should create page records with defaults', () => {
-		const page = PageRecordType.create({
-			id: 'page:test' as TLPageId,
-			name: 'Test Page',
-			index: 'a1' as any,
-		})
-
-		expect(page.meta).toEqual({})
-	})
-})
-
-describe('isPageId', () => {
-	it('should return true for valid page IDs', () => {
-		expect(isPageId('page:main')).toBe(true)
-		expect(isPageId('page:page1')).toBe(true)
-	})
-
-	it('should return false for invalid page IDs', () => {
-		expect(isPageId('shape:main')).toBe(false)
-		expect(isPageId('invalid')).toBe(false)
-		expect(isPageId('')).toBe(false)
-	})
-})