@bigbluebutton/tlschema 2.0.0-alpha.19

package/src/records/TLPageState.ts

@@ -0,0 +1,216 @@
+import { BaseRecord, createRecordType, defineMigrations, RecordId } from '@bigbluebutton/store'
+import { JsonObject } from '@bigbluebutton/utils'
+import { T } from '@bigbluebutton/validate'
+import { idValidator } from '../misc/id-validator'
+import { shapeIdValidator } from '../shapes/TLBaseShape'
+import { CameraRecordType } from './TLCamera'
+import { TLINSTANCE_ID } from './TLInstance'
+import { pageIdValidator, TLPage } from './TLPage'
+import { TLShapeId } from './TLShape'
+
+/**
+ * TLInstancePageState
+ *
+ * State that is unique to a particular page of the document in a particular browser tab
+ *
+ * @public
+ */
+export interface TLInstancePageState
+	extends BaseRecord<'instance_page_state', TLInstancePageStateId> {
+	pageId: RecordId<TLPage>
+	selectedShapeIds: TLShapeId[]
+	hintingShapeIds: TLShapeId[]
+	erasingShapeIds: TLShapeId[]
+	hoveredShapeId: TLShapeId | null
+	editingShapeId: TLShapeId | null
+	croppingShapeId: TLShapeId | null
+	focusedGroupId: TLShapeId | null
+	meta: JsonObject
+}
+
+/** @internal */
+export const instancePageStateValidator: T.Validator<TLInstancePageState> = T.model(
+	'instance_page_state',
+	T.object({
+		typeName: T.literal('instance_page_state'),
+		id: idValidator<TLInstancePageStateId>('instance_page_state'),
+		pageId: pageIdValidator,
+		selectedShapeIds: T.arrayOf(shapeIdValidator),
+		hintingShapeIds: T.arrayOf(shapeIdValidator),
+		erasingShapeIds: T.arrayOf(shapeIdValidator),
+		hoveredShapeId: shapeIdValidator.nullable(),
+		editingShapeId: shapeIdValidator.nullable(),
+		croppingShapeId: shapeIdValidator.nullable(),
+		focusedGroupId: shapeIdValidator.nullable(),
+		meta: T.jsonValue as T.ObjectValidator<JsonObject>,
+	})
+)
+
+/** @internal */
+export const instancePageStateVersions = {
+	AddCroppingId: 1,
+	RemoveInstanceIdAndCameraId: 2,
+	AddMeta: 3,
+	RenameProperties: 4,
+	RenamePropertiesAgain: 5,
+} as const
+
+/** @public */
+export const instancePageStateMigrations = defineMigrations({
+	currentVersion: instancePageStateVersions.RenamePropertiesAgain,
+	migrators: {
+		[instancePageStateVersions.AddCroppingId]: {
+			up(instance) {
+				return { ...instance, croppingShapeId: null }
+			},
+			down({ croppingShapeId: _croppingShapeId, ...instance }) {
+				return instance
+			},
+		},
+		[instancePageStateVersions.RemoveInstanceIdAndCameraId]: {
+			up({ instanceId: _, cameraId: __, ...instance }) {
+				return instance
+			},
+			down(instance) {
+				// this should never be called since we bump the schema version
+				return {
+					...instance,
+					instanceId: TLINSTANCE_ID,
+					cameraId: CameraRecordType.createId('void'),
+				}
+			},
+		},
+		[instancePageStateVersions.AddMeta]: {
+			up: (record) => {
+				return {
+					...record,
+					meta: {},
+				}
+			},
+			down: ({ meta: _, ...record }) => {
+				return {
+					...record,
+				}
+			},
+		},
+		[instancePageStateVersions.RenameProperties]: {
+			// this migration is cursed: it was written wrong and doesn't do anything.
+			// rather than replace it, I've added another migration below that fixes it.
+			up: (record) => {
+				const {
+					selectedShapeIds,
+					hintingShapeIds,
+					erasingShapeIds,
+					hoveredShapeId,
+					editingShapeId,
+					croppingShapeId,
+					focusedGroupId,
+					...rest
+				} = record
+				return {
+					selectedShapeIds: selectedShapeIds,
+					hintingShapeIds: hintingShapeIds,
+					erasingShapeIds: erasingShapeIds,
+					hoveredShapeId: hoveredShapeId,
+					editingShapeId: editingShapeId,
+					croppingShapeId: croppingShapeId,
+					focusedGroupId: focusedGroupId,
+					...rest,
+				}
+			},
+			down: (record) => {
+				const {
+					selectedShapeIds,
+					hintingShapeIds,
+					erasingShapeIds,
+					hoveredShapeId,
+					editingShapeId,
+					croppingShapeId,
+					focusedGroupId,
+					...rest
+				} = record
+				return {
+					selectedShapeIds: selectedShapeIds,
+					hintingShapeIds: hintingShapeIds,
+					erasingShapeIds: erasingShapeIds,
+					hoveredShapeId: hoveredShapeId,
+					editingShapeId: editingShapeId,
+					croppingShapeId: croppingShapeId,
+					focusedGroupId: focusedGroupId,
+					...rest,
+				}
+			},
+		},
+		[instancePageStateVersions.RenamePropertiesAgain]: {
+			up: (record) => {
+				const {
+					selectedIds,
+					hintingIds,
+					erasingIds,
+					hoveredId,
+					editingId,
+					croppingShapeId,
+					croppingId,
+					focusLayerId,
+					...rest
+				} = record
+				return {
+					...rest,
+					selectedShapeIds: selectedIds,
+					hintingShapeIds: hintingIds,
+					erasingShapeIds: erasingIds,
+					hoveredShapeId: hoveredId,
+					editingShapeId: editingId,
+					croppingShapeId: croppingShapeId ?? croppingId ?? null,
+					focusedGroupId: focusLayerId,
+				}
+			},
+			down: (record) => {
+				const {
+					selectedShapeIds,
+					hintingShapeIds,
+					erasingShapeIds,
+					hoveredShapeId,
+					editingShapeId,
+					croppingShapeId,
+					focusedGroupId,
+					...rest
+				} = record
+				return {
+					...rest,
+					selectedIds: selectedShapeIds,
+					hintingIds: hintingShapeIds,
+					erasingIds: erasingShapeIds,
+					hoveredId: hoveredShapeId,
+					editingId: editingShapeId,
+					croppingId: croppingShapeId,
+					focusLayerId: focusedGroupId,
+				}
+			},
+		},
+	},
+})
+
+/** @public */
+export const InstancePageStateRecordType = createRecordType<TLInstancePageState>(
+	'instance_page_state',
+	{
+		migrations: instancePageStateMigrations,
+		validator: instancePageStateValidator,
+		scope: 'session',
+	}
+).withDefaultProperties(
+	(): Omit<TLInstancePageState, 'id' | 'typeName' | 'pageId'> => ({
+		editingShapeId: null,
+		croppingShapeId: null,
+		selectedShapeIds: [],
+		hoveredShapeId: null,
+		erasingShapeIds: [],
+		hintingShapeIds: [],
+		focusedGroupId: null,
+		meta: {},
+	})
+)
+
+/** @public */
+export type TLInstancePageStateId = RecordId<TLInstancePageState>

package/src/records/TLPointer.ts

@@ -0,0 +1,74 @@
+import { BaseRecord, createRecordType, defineMigrations, RecordId } from '@bigbluebutton/store'
+import { JsonObject } from '@bigbluebutton/utils'
+import { T } from '@bigbluebutton/validate'
+import { idValidator } from '../misc/id-validator'
+
+/**
+ * TLPointer
+ *
+ * @public
+ */
+export interface TLPointer extends BaseRecord<'pointer', TLPointerId> {
+	x: number
+	y: number
+	lastActivityTimestamp: number
+	meta: JsonObject
+}
+
+/** @public */
+export type TLPointerId = RecordId<TLPointer>
+
+/** @internal */
+export const pointerValidator: T.Validator<TLPointer> = T.model(
+	'pointer',
+	T.object({
+		typeName: T.literal('pointer'),
+		id: idValidator<TLPointerId>('pointer'),
+		x: T.number,
+		y: T.number,
+		lastActivityTimestamp: T.number,
+		meta: T.jsonValue as T.ObjectValidator<JsonObject>,
+	})
+)
+
+/** @internal */
+export const pointerVersions = {
+	AddMeta: 1,
+}
+
+/** @internal */
+export const pointerMigrations = defineMigrations({
+	currentVersion: pointerVersions.AddMeta,
+	migrators: {
+		[pointerVersions.AddMeta]: {
+			up: (record) => {
+				return {
+					...record,
+					meta: {},
+				}
+			},
+			down: ({ meta: _, ...record }) => {
+				return {
+					...record,
+				}
+			},
+		},
+	},
+})
+
+/** @public */
+export const PointerRecordType = createRecordType<TLPointer>('pointer', {
+	validator: pointerValidator,
+	migrations: pointerMigrations,
+	scope: 'session',
+}).withDefaultProperties(
+	(): Omit<TLPointer, 'id' | 'typeName'> => ({
+		x: 0,
+		y: 0,
+		lastActivityTimestamp: 0,
+		meta: {},
+	})
+)
+
+/** @public */
+export const TLPOINTER_ID = PointerRecordType.createId('pointer')

package/src/records/TLPresence.ts

@@ -0,0 +1,179 @@
+import { BaseRecord, createRecordType, defineMigrations, RecordId } from '@bigbluebutton/store'
+import { JsonObject } from '@bigbluebutton/utils'
+import { T } from '@bigbluebutton/validate'
+import { Box2dModel, box2dModelValidator } from '../misc/geometry-types'
+import { idValidator } from '../misc/id-validator'
+import { cursorTypeValidator, TLCursor } from '../misc/TLCursor'
+import { scribbleValidator, TLScribble } from '../misc/TLScribble'
+import { TLINSTANCE_ID } from './TLInstance'
+import { TLPageId } from './TLPage'
+import { TLShapeId } from './TLShape'
+
+/** @public */
+export interface TLInstancePresence extends BaseRecord<'instance_presence', TLInstancePresenceID> {
+	userId: string
+	userName: string
+	lastActivityTimestamp: number
+	color: string // can be any hex color
+	camera: { x: number; y: number; z: number }
+	selectedShapeIds: TLShapeId[]
+	currentPageId: TLPageId
+	brush: Box2dModel | null
+	scribbles: TLScribble[]
+	screenBounds: Box2dModel
+	followingUserId: string | null
+	cursor: {
+		x: number
+		y: number
+		type: TLCursor['type']
+		rotation: number
+	}
+	chatMessage: string
+	meta: JsonObject
+}
+
+/** @public */
+export type TLInstancePresenceID = RecordId<TLInstancePresence>
+
+/** @internal */
+export const instancePresenceValidator: T.Validator<TLInstancePresence> = T.model(
+	'instance_presence',
+	T.object({
+		typeName: T.literal('instance_presence'),
+		id: idValidator<TLInstancePresenceID>('instance_presence'),
+		userId: T.string,
+		userName: T.string,
+		lastActivityTimestamp: T.number,
+		followingUserId: T.string.nullable(),
+		cursor: T.object({
+			x: T.number,
+			y: T.number,
+			type: cursorTypeValidator,
+			rotation: T.number,
+		}),
+		color: T.string,
+		camera: T.object({
+			x: T.number,
+			y: T.number,
+			z: T.number,
+		}),
+		screenBounds: box2dModelValidator,
+		selectedShapeIds: T.arrayOf(idValidator<TLShapeId>('shape')),
+		currentPageId: idValidator<TLPageId>('page'),
+		brush: box2dModelValidator.nullable(),
+		scribbles: T.arrayOf(scribbleValidator),
+		chatMessage: T.string,
+		meta: T.jsonValue as T.ObjectValidator<JsonObject>,
+	})
+)
+
+/** @internal */
+export const instancePresenceVersions = {
+	AddScribbleDelay: 1,
+	RemoveInstanceId: 2,
+	AddChatMessage: 3,
+	AddMeta: 4,
+	RenameSelectedShapeIds: 5,
+} as const
+
+export const instancePresenceMigrations = defineMigrations({
+	currentVersion: instancePresenceVersions.RenameSelectedShapeIds,
+	migrators: {
+		[instancePresenceVersions.AddScribbleDelay]: {
+			up: (instance) => {
+				if (instance.scribble !== null) {
+					return { ...instance, scribble: { ...instance.scribble, delay: 0 } }
+				}
+				return { ...instance }
+			},
+			down: (instance) => {
+				if (instance.scribble !== null) {
+					const { delay: _delay, ...rest } = instance.scribble
+					return { ...instance, scribble: rest }
+				}
+				return { ...instance }
+			},
+		},
+		[instancePresenceVersions.RemoveInstanceId]: {
+			up: ({ instanceId: _, ...instance }) => {
+				return instance
+			},
+			down: (instance) => {
+				return { ...instance, instanceId: TLINSTANCE_ID }
+			},
+		},
+		[instancePresenceVersions.AddChatMessage]: {
+			up: (instance) => {
+				return { ...instance, chatMessage: '' }
+			},
+			down: ({ chatMessage: _, ...instance }) => {
+				return instance
+			},
+		},
+		[instancePresenceVersions.AddMeta]: {
+			up: (record) => {
+				return {
+					...record,
+					meta: {},
+				}
+			},
+			down: ({ meta: _, ...record }) => {
+				return {
+					...record,
+				}
+			},
+		},
+		[instancePresenceVersions.RenameSelectedShapeIds]: {
+			up: (record) => {
+				const { selectedShapeIds, ...rest } = record
+				return {
+					selectedShapeIds: selectedShapeIds,
+					...rest,
+				}
+			},
+			down: (record) => {
+				const { selectedShapeIds, ...rest } = record
+				return {
+					selectedShapeIds: selectedShapeIds,
+					...rest,
+				}
+			},
+		},
+	},
+})
+
+/** @public */
+export const InstancePresenceRecordType = createRecordType<TLInstancePresence>(
+	'instance_presence',
+	{
+		migrations: instancePresenceMigrations,
+		validator: instancePresenceValidator,
+		scope: 'presence',
+	}
+).withDefaultProperties(() => ({
+	lastActivityTimestamp: 0,
+	followingUserId: null,
+	color: '#FF0000',
+	camera: {
+		x: 0,
+		y: 0,
+		z: 1,
+	},
+	cursor: {
+		x: 0,
+		y: 0,
+		type: 'default',
+		rotation: 0,
+	},
+	screenBounds: {
+		x: 0,
+		y: 0,
+		w: 1,
+		h: 1,
+	},
+	selectedShapeIds: [],
+	brush: null,
+	scribbles: [],
+	chatMessage: '',
+	meta: {},
+}))

package/src/records/TLRecord.ts

@@ -0,0 +1,21 @@
+import { TLAsset } from './TLAsset'
+import { TLCamera } from './TLCamera'
+import { TLDocument } from './TLDocument'
+import { TLInstance } from './TLInstance'
+import { TLPage } from './TLPage'
+import { TLInstancePageState } from './TLPageState'
+import { TLPointer } from './TLPointer'
+import { TLInstancePresence } from './TLPresence'
+import { TLShape } from './TLShape'
+
+/** @public */
+export type TLRecord =
+	| TLAsset
+	| TLCamera
+	| TLDocument
+	| TLInstance
+	| TLInstancePageState
+	| TLPage
+	| TLShape
+	| TLInstancePresence
+	| TLPointer

package/src/records/TLShape.ts

@@ -0,0 +1,214 @@
+import { createRecordType, defineMigrations, RecordId, UnknownRecord } from '@bigbluebutton/store'
+import { mapObjectMapValues } from '@bigbluebutton/utils'
+import { T } from '@bigbluebutton/validate'
+import { nanoid } from 'nanoid'
+import { SchemaShapeInfo } from '../createTLSchema'
+import { TLArrowShape } from '../shapes/TLArrowShape'
+import { createShapeValidator, TLBaseShape } from '../shapes/TLBaseShape'
+import { TLBookmarkShape } from '../shapes/TLBookmarkShape'
+import { TLDrawShape } from '../shapes/TLDrawShape'
+import { TLEmbedShape } from '../shapes/TLEmbedShape'
+import { TLFrameShape } from '../shapes/TLFrameShape'
+import { TLGeoShape } from '../shapes/TLGeoShape'
+import { TLGroupShape } from '../shapes/TLGroupShape'
+import { TLHighlightShape } from '../shapes/TLHighlightShape'
+import { TLImageShape } from '../shapes/TLImageShape'
+import { TLLineShape } from '../shapes/TLLineShape'
+import { TLNoteShape } from '../shapes/TLNoteShape'
+import { TLTextShape } from '../shapes/TLTextShape'
+import { TLVideoShape } from '../shapes/TLVideoShape'
+import { StyleProp } from '../styles/StyleProp'
+import { TLPageId } from './TLPage'
+
+/**
+ * The default set of shapes that are available in the editor.
+ *
+ * @public */
+export type TLDefaultShape =
+	| TLArrowShape
+	| TLBookmarkShape
+	| TLDrawShape
+	| TLEmbedShape
+	| TLFrameShape
+	| TLGeoShape
+	| TLGroupShape
+	| TLImageShape
+	| TLLineShape
+	| TLNoteShape
+	| TLTextShape
+	| TLVideoShape
+	| TLHighlightShape
+
+/**
+ * A type for a shape that is available in the editor but whose type is
+ * unknown—either one of the editor's default shapes or else a custom shape.
+ *
+ * @public */
+export type TLUnknownShape = TLBaseShape<string, object>
+
+/**
+ * The set of all shapes that are available in the editor, including unknown shapes.
+ *
+ * @public
+ */
+export type TLShape = TLDefaultShape | TLUnknownShape
+
+/** @public */
+export type TLShapePartial<T extends TLShape = TLShape> = T extends T
+	? {
+			id: TLShapeId
+			type: T['type']
+			props?: Partial<T['props']>
+			meta?: Partial<T['meta']>
+	  } & Partial<Omit<T, 'type' | 'id' | 'props' | 'meta'>>
+	: never
+
+/** @public */
+export type TLShapeId = RecordId<TLUnknownShape>
+
+// evil type shit that will get deleted in the next PR
+type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void
+	? I
+	: never
+
+type Identity<T> = { [K in keyof T]: T[K] }
+
+/** @public */
+export type TLShapeProps = Identity<UnionToIntersection<TLDefaultShape['props']>>
+
+/** @public */
+export type TLShapeProp = keyof TLShapeProps
+
+/** @public */
+export type TLParentId = TLPageId | TLShapeId
+
+/** @internal */
+export const rootShapeVersions = {
+	AddIsLocked: 1,
+	HoistOpacity: 2,
+	AddMeta: 3,
+} as const
+
+/** @internal */
+export const rootShapeMigrations = defineMigrations({
+	currentVersion: rootShapeVersions.AddMeta,
+	migrators: {
+		[rootShapeVersions.AddIsLocked]: {
+			up: (record) => {
+				return {
+					...record,
+					isLocked: false,
+				}
+			},
+			down: (record) => {
+				const { isLocked: _, ...rest } = record
+				return {
+					...rest,
+				}
+			},
+		},
+		[rootShapeVersions.HoistOpacity]: {
+			up: ({ props: { opacity, ...props }, ...record }) => {
+				return {
+					...record,
+					opacity: Number(opacity ?? '1'),
+					props,
+				}
+			},
+			down: ({ opacity, ...record }) => {
+				return {
+					...record,
+					props: {
+						...record.props,
+						opacity:
+							opacity < 0.175
+								? '0.1'
+								: opacity < 0.375
+								? '0.25'
+								: opacity < 0.625
+								? '0.5'
+								: opacity < 0.875
+								? '0.75'
+								: '1',
+					},
+				}
+			},
+		},
+		[rootShapeVersions.AddMeta]: {
+			up: (record) => {
+				return {
+					...record,
+					meta: {},
+				}
+			},
+			down: ({ meta: _, ...record }) => {
+				return {
+					...record,
+				}
+			},
+		},
+	},
+})
+
+/** @public */
+export function isShape(record?: UnknownRecord): record is TLShape {
+	if (!record) return false
+	return record.typeName === 'shape'
+}
+
+/** @public */
+export function isShapeId(id?: string): id is TLShapeId {
+	if (!id) return false
+	return id.startsWith('shape:')
+}
+
+/** @public */
+export function createShapeId(id?: string): TLShapeId {
+	return `shape:${id ?? nanoid()}` as TLShapeId
+}
+
+/** @internal */
+export function getShapePropKeysByStyle(props: Record<string, T.Validatable<any>>) {
+	const propKeysByStyle = new Map<StyleProp<unknown>, string>()
+	for (const [key, prop] of Object.entries(props)) {
+		if (prop instanceof StyleProp) {
+			if (propKeysByStyle.has(prop)) {
+				throw new Error(
+					`Duplicate style prop ${prop.id}. Each style prop can only be used once within a shape.`
+				)
+			}
+			propKeysByStyle.set(prop, key)
+		}
+	}
+	return propKeysByStyle
+}
+
+/** @internal */
+export function createShapeRecordType(shapes: Record<string, SchemaShapeInfo>) {
+	return createRecordType<TLShape>('shape', {
+		migrations: defineMigrations({
+			currentVersion: rootShapeMigrations.currentVersion,
+			firstVersion: rootShapeMigrations.firstVersion,
+			migrators: rootShapeMigrations.migrators,
+			subTypeKey: 'type',
+			subTypeMigrations: mapObjectMapValues(shapes, (_, v) => v.migrations ?? defineMigrations({})),
+		}),
+		scope: 'document',
+		validator: T.model(
+			'shape',
+			T.union(
+				'type',
+				mapObjectMapValues(shapes, (type, { props, meta }) =>
+					createShapeValidator(type, props, meta)
+				)
+			)
+		),
+	}).withDefaultProperties(() => ({
+		x: 0,
+		y: 0,
+		rotation: 0,
+		isLocked: false,
+		opacity: 1,
+		meta: {},
+	}))
+}