Function createTLSchema

packages/tlschema/src/createTLSchema.ts:339–437

({
	shapes = defaultShapeSchemas,
	bindings = defaultBindingSchemas,
	assets = defaultAssetSchemas,
	user,
	records = {},
	migrations,
}: {
	shapes?: Record<string, SchemaPropsInfo>
	bindings?: Record<string, SchemaPropsInfo>
	assets?: Record<string, SchemaPropsInfo>
	user?: UserSchemaInfo
	records?: Record<string, CustomRecordInfo>
	migrations?: readonly MigrationSequence[]
} = {})

 * ```
 */
export function createTLSchema({
	shapes = defaultShapeSchemas,
	bindings = defaultBindingSchemas,
	assets = defaultAssetSchemas,
	user,
	records = {},
	migrations,
}: {
	shapes?: Record<string, SchemaPropsInfo>
	bindings?: Record<string, SchemaPropsInfo>
	assets?: Record<string, SchemaPropsInfo>
	user?: UserSchemaInfo
	records?: Record<string, CustomRecordInfo>
	migrations?: readonly MigrationSequence[]
} = {}): TLSchema {
	const stylesById = new Map<string, StyleProp<unknown>>()
	for (const shape of objectMapValues(shapes)) {
		for (const style of getShapePropKeysByStyle(shape.props ?? {}).keys()) {
			if (stylesById.has(style.id) && stylesById.get(style.id) !== style) {
				throw new Error(`Multiple StyleProp instances with the same id: ${style.id}`)
			}
			stylesById.set(style.id, style)
		}
	}

	const ShapeRecordType = createShapeRecordType(shapes)
	const BindingRecordType = createBindingRecordType(bindings)
	const _AssetRecordType = createAssetRecordType(assets)
	const InstanceRecordType = createInstanceRecordType(stylesById)
	const CustomUserRecordType = user ? createUserRecordType(user) : UserRecordType

	// Create RecordTypes for custom records
	const builtInTypeNames = new Set([
		'asset',
		'binding',
		'camera',
		'document',
		'instance',
		'instance_page_state',
		'page',
		'instance_presence',
		'pointer',
		'shape',
		'store',
		'user',
	])
	const customRecordTypes: Record<string, { createId: any }> = {}
	for (const [typeName, config] of Object.entries(records)) {
		if (builtInTypeNames.has(typeName)) {
			throw new Error(
				`Custom record type name '${typeName}' conflicts with tldraw's built-in record type of that name. Choose a different name instead.`
			)
		}
		customRecordTypes[typeName] = createCustomRecordType(typeName, config)
	}

	return StoreSchema.create(
		{