@bigbluebutton/tlschema 2.0.0-alpha.19

package/src/createTLSchema.ts

@@ -0,0 +1,65 @@
+import { Migrations, StoreSchema } from '@bigbluebutton/store'
+import { objectMapValues } from '@bigbluebutton/utils'
+import { TLStoreProps, createIntegrityChecker, onValidationFailure } from './TLStore'
+import { AssetRecordType } from './records/TLAsset'
+import { CameraRecordType } from './records/TLCamera'
+import { DocumentRecordType } from './records/TLDocument'
+import { createInstanceRecordType } from './records/TLInstance'
+import { PageRecordType } from './records/TLPage'
+import { InstancePageStateRecordType } from './records/TLPageState'
+import { PointerRecordType } from './records/TLPointer'
+import { InstancePresenceRecordType } from './records/TLPresence'
+import { TLRecord } from './records/TLRecord'
+import { createShapeRecordType, getShapePropKeysByStyle } from './records/TLShape'
+import { storeMigrations } from './store-migrations'
+import { StyleProp } from './styles/StyleProp'
+
+/** @public */
+export type SchemaShapeInfo = {
+	migrations?: Migrations
+	props?: Record<string, { validate: (prop: any) => any }>
+	meta?: Record<string, { validate: (prop: any) => any }>
+}
+
+/** @public */
+export type TLSchema = StoreSchema<TLRecord, TLStoreProps>
+
+/**
+ * Create a TLSchema with custom shapes. Custom shapes cannot override default shapes.
+ *
+ * @param opts - Options
+ *
+ * @public */
+export function createTLSchema({ shapes }: { shapes: Record<string, SchemaShapeInfo> }): 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 InstanceRecordType = createInstanceRecordType(stylesById)
+
+	return StoreSchema.create(
+		{
+			asset: AssetRecordType,
+			camera: CameraRecordType,
+			document: DocumentRecordType,
+			instance: InstanceRecordType,
+			instance_page_state: InstancePageStateRecordType,
+			page: PageRecordType,
+			shape: ShapeRecordType,
+			instance_presence: InstancePresenceRecordType,
+			pointer: PointerRecordType,
+		},
+		{
+			snapshotMigrations: storeMigrations,
+			onValidationFailure,
+			createIntegrityChecker: createIntegrityChecker,
+		}
+	)
+}

package/src/index.ts

@@ -0,0 +1,168 @@
+export {
+	type TLSerializedStore,
+	type TLStore,
+	type TLStoreProps,
+	type TLStoreSchema,
+	type TLStoreSnapshot,
+} from './TLStore'
+export { assetIdValidator, createAssetValidator, type TLBaseAsset } from './assets/TLBaseAsset'
+export { type TLBookmarkAsset } from './assets/TLBookmarkAsset'
+export { type TLImageAsset } from './assets/TLImageAsset'
+export { type TLVideoAsset } from './assets/TLVideoAsset'
+export { createPresenceStateDerivation } from './createPresenceStateDerivation'
+export { createTLSchema, type SchemaShapeInfo, type TLSchema } from './createTLSchema'
+export {
+	TL_CANVAS_UI_COLOR_TYPES,
+	canvasUiColorTypeValidator,
+	type TLCanvasUiColor,
+} from './misc/TLColor'
+export { type TLCursor, type TLCursorType } from './misc/TLCursor'
+export { type TLHandle, type TLHandleType } from './misc/TLHandle'
+export { opacityValidator, type TLOpacityType } from './misc/TLOpacity'
+export { scribbleValidator, type TLScribble } from './misc/TLScribble'
+export {
+	box2dModelValidator,
+	vec2dModelValidator,
+	type Box2dModel,
+	type Vec2dModel,
+} from './misc/geometry-types'
+export { idValidator } from './misc/id-validator'
+export {
+	AssetRecordType,
+	assetMigrations,
+	assetValidator,
+	type TLAsset,
+	type TLAssetId,
+	type TLAssetPartial,
+	type TLAssetShape,
+} from './records/TLAsset'
+export { CameraRecordType, type TLCamera, type TLCameraId } from './records/TLCamera'
+export { DocumentRecordType, TLDOCUMENT_ID, type TLDocument } from './records/TLDocument'
+export { TLINSTANCE_ID, type TLInstance, type TLInstanceId } from './records/TLInstance'
+export {
+	PageRecordType,
+	isPageId,
+	pageIdValidator,
+	type TLPage,
+	type TLPageId,
+} from './records/TLPage'
+export { InstancePageStateRecordType, type TLInstancePageState } from './records/TLPageState'
+export { PointerRecordType, TLPOINTER_ID } from './records/TLPointer'
+export { InstancePresenceRecordType, type TLInstancePresence } from './records/TLPresence'
+export { type TLRecord } from './records/TLRecord'
+export {
+	createShapeId,
+	getShapePropKeysByStyle,
+	isShape,
+	isShapeId,
+	rootShapeMigrations,
+	type TLDefaultShape,
+	type TLParentId,
+	type TLShape,
+	type TLShapeId,
+	type TLShapePartial,
+	type TLShapeProp,
+	type TLShapeProps,
+	type TLUnknownShape,
+} from './records/TLShape'
+export {
+	ArrowShapeArrowheadEndStyle,
+	ArrowShapeArrowheadStartStyle,
+	arrowShapeMigrations,
+	arrowShapeProps,
+	type TLArrowShape,
+	type TLArrowShapeArrowheadStyle,
+	type TLArrowShapeProps,
+	type TLArrowShapeTerminal,
+} from './shapes/TLArrowShape'
+export {
+	createShapeValidator,
+	parentIdValidator,
+	shapeIdValidator,
+	type ShapeProps,
+	type TLBaseShape,
+} from './shapes/TLBaseShape'
+export {
+	bookmarkShapeMigrations,
+	bookmarkShapeProps,
+	type TLBookmarkShape,
+} from './shapes/TLBookmarkShape'
+export {
+	drawShapeMigrations,
+	drawShapeProps,
+	type TLDrawShape,
+	type TLDrawShapeSegment,
+} from './shapes/TLDrawShape'
+export {
+	EMBED_DEFINITIONS,
+	embedShapeMigrations,
+	embedShapePermissionDefaults,
+	embedShapeProps,
+	type EmbedDefinition,
+	type TLEmbedShape,
+	type TLEmbedShapePermissions,
+} from './shapes/TLEmbedShape'
+export { frameShapeMigrations, frameShapeProps, type TLFrameShape } from './shapes/TLFrameShape'
+export {
+	GeoShapeGeoStyle,
+	geoShapeMigrations,
+	geoShapeProps,
+	type TLGeoShape,
+} from './shapes/TLGeoShape'
+export { groupShapeMigrations, groupShapeProps, type TLGroupShape } from './shapes/TLGroupShape'
+export {
+	highlightShapeMigrations,
+	highlightShapeProps,
+	type TLHighlightShape,
+} from './shapes/TLHighlightShape'
+export {
+	imageShapeMigrations,
+	imageShapeProps,
+	type TLImageShape,
+	type TLImageShapeCrop,
+	type TLImageShapeProps,
+} from './shapes/TLImageShape'
+export {
+	LineShapeSplineStyle,
+	lineShapeMigrations,
+	lineShapeProps,
+	type TLLineShape,
+} from './shapes/TLLineShape'
+export { noteShapeMigrations, noteShapeProps, type TLNoteShape } from './shapes/TLNoteShape'
+export {
+	textShapeMigrations,
+	textShapeProps,
+	type TLTextShape,
+	type TLTextShapeProps,
+} from './shapes/TLTextShape'
+export { videoShapeMigrations, videoShapeProps, type TLVideoShape } from './shapes/TLVideoShape'
+export { EnumStyleProp, StyleProp } from './styles/StyleProp'
+export {
+	DefaultColorStyle,
+	DefaultColorThemePalette,
+	getDefaultColorTheme,
+	type TLDefaultColorStyle,
+	type TLDefaultColorTheme,
+	type TLDefaultColorThemeColor,
+} from './styles/TLColorStyle'
+export { DefaultDashStyle, type TLDefaultDashStyle } from './styles/TLDashStyle'
+export { DefaultFillStyle, type TLDefaultFillStyle } from './styles/TLFillStyle'
+export {
+	DefaultFontFamilies,
+	DefaultFontStyle,
+	type TLDefaultFontStyle,
+} from './styles/TLFontStyle'
+export {
+	DefaultHorizontalAlignStyle,
+	type TLDefaultHorizontalAlignStyle,
+} from './styles/TLHorizontalAlignStyle'
+export { DefaultSizeStyle, type TLDefaultSizeStyle } from './styles/TLSizeStyle'
+export {
+	DefaultVerticalAlignStyle,
+	type TLDefaultVerticalAlignStyle,
+} from './styles/TLVerticalAlignStyle'
+export {
+	LANGUAGES,
+	getDefaultTranslationLocale,
+	type TLLanguage,
+} from './translations/translations'