/* -------------------------------------------------- */ /* Client State */ /* -------------------------------------------------- */ export interface Data { isReadOnly: boolean settings: { fontSize: number isDarkMode: boolean isCodeOpen: boolean isTestMode: boolean isDebugOpen: boolean isDebugMode: boolean isStyleOpen: boolean nudgeDistanceSmall: number nudgeDistanceLarge: number isToolLocked: boolean isPenLocked: boolean } room?: { id: string status: string peers: Record } currentStyle: ShapeStyles activeTool: ShapeType | 'select' brush?: Bounds boundsRotation: number pointedId?: string hoveredId?: string editingId?: string currentPageId: string currentParentId: string currentCodeFileId: string codeControls: Record document: TLDocument pageStates: Record } /* -------------------------------------------------- */ /* Document */ /* -------------------------------------------------- */ export type CoopPresence = { id: string bufferedXs: number[] bufferedYs: number[] times: number[] duration: number pageId: string } export interface TLDocument { id: string name: string pages: Record code: Record } export interface Page { id: string type: 'page' childIndex: number name: string shapes: Record } export interface PageState { id: string selectedIds: string[] camera: { point: number[] zoom: number } } /* ----------------- Start Copy Here ---------------- */ export enum ShapeType { Dot = 'dot', Ellipse = 'ellipse', Line = 'line', Ray = 'ray', Polyline = 'polyline', Rectangle = 'rectangle', Draw = 'draw', Arrow = 'arrow', Text = 'text', Group = 'group', } export enum ColorStyle { White = 'White', LightGray = 'LightGray', Gray = 'Gray', Black = 'Black', Green = 'Green', Cyan = 'Cyan', Blue = 'Blue', Indigo = 'Indigo', Violet = 'Violet', Red = 'Red', Orange = 'Orange', Yellow = 'Yellow', } export enum SizeStyle { Small = 'Small', Medium = 'Medium', Large = 'Large', } export enum DashStyle { Draw = 'Draw', Solid = 'Solid', Dashed = 'Dashed', Dotted = 'Dotted', } export enum FontSize { Small = 'Small', Medium = 'Medium', Large = 'Large', ExtraLarge = 'ExtraLarge', } export type ShapeStyles = { color: ColorStyle size: SizeStyle dash: DashStyle isFilled: boolean } export interface BaseShape { id: string type: ShapeType parentId: string childIndex: number name: string point: number[] style: ShapeStyles rotation: number children?: string[] bindings?: Record handles?: Record isLocked?: boolean isHidden?: boolean isEditing?: boolean isGenerated?: boolean isAspectRatioLocked?: boolean } export interface DotShape extends BaseShape { type: ShapeType.Dot } export interface EllipseShape extends BaseShape { type: ShapeType.Ellipse radiusX: number radiusY: number } export interface LineShape extends BaseShape { type: ShapeType.Line direction: number[] } export interface RayShape extends BaseShape { type: ShapeType.Ray direction: number[] } export interface PolylineShape extends BaseShape { type: ShapeType.Polyline points: number[][] } export interface RectangleShape extends BaseShape { type: ShapeType.Rectangle size: number[] radius: number } export interface DrawShape extends BaseShape { type: ShapeType.Draw points: number[][] } export interface ArrowShape extends BaseShape { type: ShapeType.Arrow handles: Record bend: number decorations?: { start: Decoration end: Decoration middle: Decoration } } export interface TextShape extends BaseShape { type: ShapeType.Text text: string scale: number } export interface GroupShape extends BaseShape { type: ShapeType.Group children: string[] size: number[] } export type ShapeProps = { [P in keyof T]?: P extends 'style' ? Partial : T[P] } export interface MutableShapes { [ShapeType.Dot]: DotShape [ShapeType.Ellipse]: EllipseShape [ShapeType.Line]: LineShape [ShapeType.Ray]: RayShape [ShapeType.Polyline]: PolylineShape [ShapeType.Draw]: DrawShape [ShapeType.Rectangle]: RectangleShape [ShapeType.Arrow]: ArrowShape [ShapeType.Text]: TextShape [ShapeType.Group]: GroupShape } export type MutableShape = MutableShapes[keyof MutableShapes] export type Shapes = { [K in keyof MutableShapes]: Readonly } export type Shape = Readonly export type ShapeByType = Shapes[T] export type IsParent = 'children' extends RequiredKeys ? T : never export type ParentShape = { [K in keyof MutableShapes]: IsParent }[keyof MutableShapes] export type ParentTypes = ParentShape['type'] & 'page' export enum Decoration { Arrow = 'Arrow', } export interface ShapeBinding { id: string index: number point: number[] } export interface ShapeHandle { id: string index: number point: number[] } export interface CodeFile { id: string name: string code: string } export interface CodeError { message: string line: number column: number } export interface CodeResult { shapes: Shape[] controls: CodeControl[] error: CodeError } /* -------------------------------------------------- */ /* Editor UI */ /* -------------------------------------------------- */ export interface PointerInfo { target: string pointerId: number origin: number[] point: number[] pressure: number shiftKey: boolean ctrlKey: boolean metaKey: boolean altKey: boolean } export interface KeyboardInfo { key: string keys: string[] shiftKey: boolean ctrlKey: boolean metaKey: boolean altKey: boolean } export enum Edge { Top = 'top_edge', Right = 'right_edge', Bottom = 'bottom_edge', Left = 'left_edge', } export enum Corner { TopLeft = 'top_left_corner', TopRight = 'top_right_corner', BottomRight = 'bottom_right_corner', BottomLeft = 'bottom_left_corner', } export interface Bounds { minX: number minY: number maxX: number maxY: number width: number height: number rotation?: number } export interface RotatedBounds extends Bounds { rotation: number } export interface ShapeBounds extends Bounds { id: string } export interface PointSnapshot extends Bounds { nx: number nmx: number ny: number nmy: number } export interface BoundsSnapshot extends PointSnapshot { nw: number nh: number } export type ShapeSpecificProps = Pick< T, Difference > export type ShapeIndicatorProps = ShapeSpecificProps export type ShapeUtil = { create(props: Partial): K getBounds(shape: K): Bounds hitTest(shape: K, test: number[]): boolean hitTestBounds(shape: K, bounds: Bounds): boolean rotate(shape: K): K translate(shape: K, delta: number[]): K scale(shape: K, scale: number): K stretch(shape: K, scaleX: number, scaleY: number): K render(shape: K): JSX.Element } export enum MoveType { Backward, Forward, ToFront, ToBack, } export enum AlignType { Top, CenterVertical, Bottom, Left, CenterHorizontal, Right, } export enum StretchType { Horizontal, Vertical, } export enum DistributeType { Horizontal, Vertical, } export interface BezierCurveSegment { start: number[] tangentStart: number[] normalStart: number[] pressureStart: number end: number[] tangentEnd: number[] normalEnd: number[] pressureEnd: number } /* -------------------------------------------------- */ /* Code Editor */ /* -------------------------------------------------- */ export enum ControlType { Number = 'number', Vector = 'vector', Text = 'text', Select = 'select', } export interface BaseCodeControl { id: string type: ControlType label: string } export interface NumberCodeControl extends BaseCodeControl { type: ControlType.Number value: number min?: number max?: number step?: number format?: (value: number) => number } export interface VectorCodeControl extends BaseCodeControl { type: ControlType.Vector value: number[] min?: number max?: number step?: number isNormalized?: boolean format?: (value: number[]) => number[] } export interface TextCodeControl extends BaseCodeControl { type: ControlType.Text value: string format?: (value: string) => string } export interface SelectCodeControl extends BaseCodeControl { type: ControlType.Select value: T options: T[] format?: (string: T) => string } export type CodeControl = | NumberCodeControl | VectorCodeControl | TextCodeControl export type PropsOfType> = { [K in keyof T]: T[K] extends boolean ? K : never }[keyof T] export type Mutable = { -readonly [K in keyof T]: T[K] } export interface ShapeUtility { // Default properties when creating a new shape defaultProps: K // A cache for the computed bounds of this kind of shape. boundsCache: WeakMap // Whether to show transform controls when this shape is selected. canTransform: boolean // Whether the shape's aspect ratio can change. canChangeAspectRatio: boolean // Whether the shape's style can be filled. canStyleFill: boolean // Whether the shape may be edited in an editing mode canEdit: boolean // Whether the shape is a foreign object. isForeignObject: boolean // Whether the shape can contain other shapes. isParent: boolean // Whether the shape is only shown when on hovered. isShy: boolean // Create a new shape. create(this: ShapeUtility, props: Partial): K // Update a shape's styles applyStyles( this: ShapeUtility, shape: Mutable, style: Partial ): ShapeUtility translateBy( this: ShapeUtility, shape: Mutable, point: number[] ): ShapeUtility translateTo( this: ShapeUtility, shape: Mutable, point: number[] ): ShapeUtility rotateBy( this: ShapeUtility, shape: Mutable, rotation: number ): ShapeUtility rotateTo( this: ShapeUtility, shape: Mutable, rotation: number, delta: number ): ShapeUtility // Transform to fit a new bounding box when more than one shape is selected. transform( this: ShapeUtility, shape: Mutable, bounds: Bounds, info: { type: Edge | Corner initialShape: K scaleX: number scaleY: number transformOrigin: number[] } ): ShapeUtility // Transform a single shape to fit a new bounding box. transformSingle( this: ShapeUtility, shape: Mutable, bounds: Bounds, info: { type: Edge | Corner initialShape: K scaleX: number scaleY: number transformOrigin: number[] } ): ShapeUtility setProperty

( this: ShapeUtility, shape: Mutable, prop: P, value: K[P] ): ShapeUtility // Respond when any child of this shape changes. onChildrenChange( this: ShapeUtility, shape: Mutable, children: Shape[] ): ShapeUtility // Respond when a user moves one of the shape's bound elements. onBindingChange( this: ShapeUtility, shape: Mutable, bindings: Record ): ShapeUtility // Respond when a user moves one of the shape's handles. onHandleChange( this: ShapeUtility, shape: Mutable, handle: Partial, info?: Partial<{ delta: number[] shiftKey: boolean altKey: boolean metaKey: boolean }> ): ShapeUtility onDoublePointHandle( this: ShapeUtility, shape: Mutable, handle: keyof K['handles'], info: PointerInfo ): ShapeUtility // Respond when a user double clicks the shape's bounds. onBoundsReset(this: ShapeUtility, shape: Mutable): ShapeUtility // Respond when a user double clicks the center of the shape. onDoubleFocus(this: ShapeUtility, shape: Mutable): ShapeUtility // Clean up changes when a session ends. onSessionComplete(this: ShapeUtility, shape: Mutable): ShapeUtility // Render a shape to JSX. render( this: ShapeUtility, shape: K, info?: { isEditing?: boolean isHovered?: boolean isSelected?: boolean isCurrentParent?: boolean ref?: React.MutableRefObject } ): JSX.Element invalidate(this: ShapeUtility, shape: K): ShapeUtility // Get the bounds of the a shape. getBounds(this: ShapeUtility, shape: K): Bounds // Get the routated bounds of the a shape. getRotatedBounds(this: ShapeUtility, shape: K): Bounds // Get the center of the shape getCenter(this: ShapeUtility, shape: K): number[] // Test whether a point lies within a shape. hitTest(this: ShapeUtility, shape: K, test: number[]): boolean // Test whether bounds collide with or contain a shape. hitTestBounds(this: ShapeUtility, shape: K, bounds: Bounds): boolean // Get whether the shape should delete shouldDelete(this: ShapeUtility, shape: K): boolean // Get whether the shape should render shouldRender(this: ShapeUtility, shape: K, previous: K): boolean } /* -------------------------------------------------- */ /* Utilities */ /* -------------------------------------------------- */ export type Difference = A extends B ? never : A export type RequiredKeys = { [K in keyof T]-?: Record extends Pick ? never : K }[keyof T]