@bigbluebutton/tlschema 2.0.0-alpha.19

package/src/misc/TLColor.ts

@@ -0,0 +1,28 @@
+import { T } from '@bigbluebutton/validate'
+import { SetValue } from '../util-types'
+
+/**
+ * The colors used by tldraw's default shapes.
+ *
+ *  @public */
+export const TL_CANVAS_UI_COLOR_TYPES = new Set([
+	'accent',
+	'white',
+	'black',
+	'selection-stroke',
+	'selection-fill',
+	'laser',
+	'muted-1',
+] as const)
+
+/**
+ * A type for the colors used by tldraw's default shapes.
+ *
+ *  @public */
+export type TLCanvasUiColor = SetValue<typeof TL_CANVAS_UI_COLOR_TYPES>
+
+/**
+ * A validator for the colors used by tldraw's default shapes.
+ *
+ * @public */
+export const canvasUiColorTypeValidator = T.setEnum(TL_CANVAS_UI_COLOR_TYPES)

package/src/misc/TLCursor.ts

@@ -0,0 +1,54 @@
+import { T } from '@bigbluebutton/validate'
+import { SetValue } from '../util-types'
+
+/**
+ * The cursor types used by tldraw's default shapes.
+ *
+ * @public */
+export const TL_CURSOR_TYPES = new Set([
+	'none',
+	'default',
+	'pointer',
+	'cross',
+	'grab',
+	'rotate',
+	'grabbing',
+	'resize-edge',
+	'resize-corner',
+	'text',
+	'move',
+	'ew-resize',
+	'ns-resize',
+	'nesw-resize',
+	'nwse-resize',
+	'nesw-rotate',
+	'nwse-rotate',
+	'swne-rotate',
+	'senw-rotate',
+	'zoom-in',
+	'zoom-out',
+])
+
+/**
+ * A type for the cursor types used by tldraw's default shapes.
+ *
+ *  @public */
+export type TLCursorType = SetValue<typeof TL_CURSOR_TYPES>
+
+/** @internal */
+export const cursorTypeValidator = T.setEnum(TL_CURSOR_TYPES)
+
+/**
+ * A cursor used by tldraw.
+ *
+ *  @public */
+export interface TLCursor {
+	type: TLCursorType
+	rotation: number
+}
+
+/** @internal */
+export const cursorValidator: T.Validator<TLCursor> = T.object<TLCursor>({
+	type: cursorTypeValidator,
+	rotation: T.number,
+})

package/src/misc/TLHandle.ts

@@ -0,0 +1,41 @@
+import { T } from '@bigbluebutton/validate'
+import { SetValue } from '../util-types'
+
+/**
+ * The handle types used by tldraw's default shapes.
+ *
+ * @public */
+export const TL_HANDLE_TYPES = new Set(['vertex', 'virtual', 'create'] as const)
+
+/**
+ * A type for the handle types used by tldraw's default shapes.
+ *
+ * @public */
+export type TLHandleType = SetValue<typeof TL_HANDLE_TYPES>
+
+/**
+ * A base interface for a shape's handles.
+ *
+ * @public
+ */
+export interface TLHandle {
+	/** A unique identifier for the handle. */
+	id: string
+	type: TLHandleType
+	canBind?: boolean
+	canSnap?: boolean
+	index: string
+	x: number
+	y: number
+}
+
+/** @internal */
+export const handleValidator: T.Validator<TLHandle> = T.object({
+	id: T.string,
+	type: T.setEnum(TL_HANDLE_TYPES),
+	canBind: T.boolean.optional(),
+	canSnap: T.boolean.optional(),
+	index: T.string,
+	x: T.number,
+	y: T.number,
+})

package/src/misc/TLOpacity.ts

@@ -0,0 +1,11 @@
+import { T } from '@bigbluebutton/validate'
+
+/** @public */
+export type TLOpacityType = number
+
+/** @internal */
+export const opacityValidator = T.number.check((n) => {
+	if (n < 0 || n > 1) {
+		throw new T.ValidationError('Opacity must be between 0 and 1')
+	}
+})

package/src/misc/TLScribble.ts

@@ -0,0 +1,39 @@
+import { T } from '@bigbluebutton/validate'
+import { SetValue } from '../util-types'
+import { TLCanvasUiColor, canvasUiColorTypeValidator } from './TLColor'
+import { Vec2dModel, vec2dModelValidator } from './geometry-types'
+
+/**
+ * The scribble states used by tldraw.
+ *
+ *  @public */
+export const TL_SCRIBBLE_STATES = new Set(['starting', 'paused', 'active', 'stopping'] as const)
+
+/**
+ * A type for the scribble used by tldraw.
+ *
+ * @public */
+export type TLScribble = {
+	id: string
+	points: Vec2dModel[]
+	size: number
+	color: TLCanvasUiColor
+	opacity: number
+	state: SetValue<typeof TL_SCRIBBLE_STATES>
+	delay: number
+	shrink: number
+	taper: boolean
+}
+
+/** @internal */
+export const scribbleValidator: T.Validator<TLScribble> = T.object({
+	id: T.string,
+	points: T.arrayOf(vec2dModelValidator),
+	size: T.positiveNumber,
+	color: canvasUiColorTypeValidator,
+	opacity: T.number,
+	state: T.setEnum(TL_SCRIBBLE_STATES),
+	delay: T.number,
+	shrink: T.number,
+	taper: T.boolean,
+})

package/src/misc/geometry-types.ts

@@ -0,0 +1,37 @@
+import { T } from '@bigbluebutton/validate'
+
+/**
+ * A serializable model for 2D boxes.
+ *
+ * @public */
+export interface Box2dModel {
+	x: number
+	y: number
+	w: number
+	h: number
+}
+
+/**
+ * A serializable model for 2D vectors.
+ *
+ * @public */
+export interface Vec2dModel {
+	x: number
+	y: number
+	z?: number
+}
+
+/** @public */
+export const vec2dModelValidator: T.Validator<Vec2dModel> = T.object({
+	x: T.number,
+	y: T.number,
+	z: T.number.optional(),
+})
+
+/** @public */
+export const box2dModelValidator: T.Validator<Box2dModel> = T.object({
+	x: T.number,
+	y: T.number,
+	w: T.number,
+	h: T.number,
+})

package/src/misc/id-validator.ts

@@ -0,0 +1,14 @@
+import type { RecordId, UnknownRecord } from '@bigbluebutton/store'
+import { T } from '@bigbluebutton/validate'
+
+/** @internal */
+export function idValidator<Id extends RecordId<UnknownRecord>>(
+	prefix: Id['__type__']['typeName']
+): T.Validator<Id> {
+	return T.string.refine((id) => {
+		if (!id.startsWith(`${prefix}:`)) {
+			throw new Error(`${prefix} ID must start with "${prefix}:"`)
+		}
+		return id as Id
+	})
+}

package/src/records/TLAsset.ts

@@ -0,0 +1,80 @@
+import { createRecordType, defineMigrations, RecordId } from '@bigbluebutton/store'
+import { T } from '@bigbluebutton/validate'
+import { TLBaseAsset } from '../assets/TLBaseAsset'
+import {
+	bookmarkAssetMigrations,
+	bookmarkAssetValidator,
+	TLBookmarkAsset,
+} from '../assets/TLBookmarkAsset'
+import { imageAssetMigrations, imageAssetValidator, TLImageAsset } from '../assets/TLImageAsset'
+import { TLVideoAsset, videoAssetMigrations, videoAssetValidator } from '../assets/TLVideoAsset'
+import { TLShape } from './TLShape'
+
+/** @public */
+export type TLAsset = TLImageAsset | TLVideoAsset | TLBookmarkAsset
+
+/** @internal */
+export const assetValidator: T.Validator<TLAsset> = T.model(
+	'asset',
+	T.union('type', {
+		image: imageAssetValidator,
+		video: videoAssetValidator,
+		bookmark: bookmarkAssetValidator,
+	})
+)
+
+/** @internal */
+export const assetVersions = {
+	AddMeta: 1,
+}
+
+/** @internal */
+export const assetMigrations = defineMigrations({
+	subTypeKey: 'type',
+	subTypeMigrations: {
+		image: imageAssetMigrations,
+		video: videoAssetMigrations,
+		bookmark: bookmarkAssetMigrations,
+	},
+	currentVersion: assetVersions.AddMeta,
+	migrators: {
+		[assetVersions.AddMeta]: {
+			up: (record) => {
+				return {
+					...record,
+					meta: {},
+				}
+			},
+			down: ({ meta: _, ...record }) => {
+				return {
+					...record,
+				}
+			},
+		},
+	},
+})
+
+/** @public */
+export type TLAssetPartial<T extends TLAsset = TLAsset> = T extends T
+	? {
+			id: TLAssetId
+			type: T['type']
+			props?: Partial<T['props']>
+			meta?: Partial<T['meta']>
+	  } & Partial<Omit<T, 'type' | 'id' | 'props' | 'meta'>>
+	: never
+
+/** @public */
+export const AssetRecordType = createRecordType<TLAsset>('asset', {
+	migrations: assetMigrations,
+	validator: assetValidator,
+	scope: 'document',
+}).withDefaultProperties(() => ({
+	meta: {},
+}))
+
+/** @public */
+export type TLAssetId = RecordId<TLBaseAsset<any, any>>
+
+/** @public */
+export type TLAssetShape = Extract<TLShape, { props: { assetId: TLAssetId } }>

package/src/records/TLCamera.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'
+
+/**
+ * A camera record.
+ *
+ * @public
+ */
+export interface TLCamera extends BaseRecord<'camera', TLCameraId> {
+	x: number
+	y: number
+	z: number
+	meta: JsonObject
+}
+
+/**
+ * The id of a camera record.
+ *
+ * @public */
+export type TLCameraId = RecordId<TLCamera>
+
+/** @internal */
+export const cameraValidator: T.Validator<TLCamera> = T.model(
+	'camera',
+	T.object({
+		typeName: T.literal('camera'),
+		id: idValidator<TLCameraId>('camera'),
+		x: T.number,
+		y: T.number,
+		z: T.number,
+		meta: T.jsonValue as T.ObjectValidator<JsonObject>,
+	})
+)
+
+/** @internal */
+export const cameraVersions = {
+	AddMeta: 1,
+}
+
+/** @internal */
+export const cameraMigrations = defineMigrations({
+	currentVersion: cameraVersions.AddMeta,
+	migrators: {
+		[cameraVersions.AddMeta]: {
+			up: (record) => {
+				return {
+					...record,
+					meta: {},
+				}
+			},
+			down: ({ meta: _, ...record }) => {
+				return {
+					...record,
+				}
+			},
+		},
+	},
+})
+
+/** @public */
+export const CameraRecordType = createRecordType<TLCamera>('camera', {
+	validator: cameraValidator,
+	migrations: cameraMigrations,
+	scope: 'session',
+}).withDefaultProperties(
+	(): Omit<TLCamera, 'id' | 'typeName'> => ({
+		x: 0,
+		y: 0,
+		z: 1,
+		meta: {},
+	})
+)

package/src/records/TLDocument.ts

@@ -0,0 +1,77 @@
+import { BaseRecord, createRecordType, defineMigrations, RecordId } from '@bigbluebutton/store'
+import { JsonObject } from '@bigbluebutton/utils'
+import { T } from '@bigbluebutton/validate'
+
+/**
+ * TLDocument
+ *
+ * @public
+ */
+export interface TLDocument extends BaseRecord<'document', RecordId<TLDocument>> {
+	gridSize: number
+	name: string
+	meta: JsonObject
+}
+
+/** @internal */
+export const documentValidator: T.Validator<TLDocument> = T.model(
+	'document',
+	T.object({
+		typeName: T.literal('document'),
+		id: T.literal('document:document' as RecordId<TLDocument>),
+		gridSize: T.number,
+		name: T.string,
+		meta: T.jsonValue as T.ObjectValidator<JsonObject>,
+	})
+)
+
+/** @internal */
+export const documentVersions = {
+	AddName: 1,
+	AddMeta: 2,
+} as const
+
+/** @internal */
+export const documentMigrations = defineMigrations({
+	currentVersion: documentVersions.AddMeta,
+	migrators: {
+		[documentVersions.AddName]: {
+			up: (document: TLDocument) => {
+				return { ...document, name: '' }
+			},
+			down: ({ name: _, ...document }: TLDocument) => {
+				return document
+			},
+		},
+		[documentVersions.AddMeta]: {
+			up: (record) => {
+				return {
+					...record,
+					meta: {},
+				}
+			},
+			down: ({ meta: _, ...record }) => {
+				return {
+					...record,
+				}
+			},
+		},
+	},
+})
+
+/** @public */
+export const DocumentRecordType = createRecordType<TLDocument>('document', {
+	migrations: documentMigrations,
+	validator: documentValidator,
+	scope: 'document',
+}).withDefaultProperties(
+	(): Omit<TLDocument, 'id' | 'typeName'> => ({
+		gridSize: 10,
+		name: '',
+		meta: {},
+	})
+)
+
+// all document records have the same ID: 'document:document'
+/** @public */
+export const TLDOCUMENT_ID: RecordId<TLDocument> = DocumentRecordType.createId('document')