@tldraw/tlschema 4.6.0-next.1f489710ee41 → 4.6.0-next.4dde09fa17ab

package/dist-esm/shapes/TLNoteShape.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/shapes/TLNoteShape.ts"],
-  "sourcesContent": ["import { T } from '@tldraw/validate'\nimport { TLRichText, richTextValidator, toRichText } from '../misc/TLRichText'\nimport { createShapePropsMigrationIds, createShapePropsMigrationSequence } from '../records/TLShape'\nimport { RecordProps } from '../recordsWithProps'\nimport {\n\tDefaultColorStyle,\n\tDefaultLabelColorStyle,\n\tTLDefaultColorStyle,\n} from '../styles/TLColorStyle'\nimport { DefaultFontStyle, TLDefaultFontStyle } from '../styles/TLFontStyle'\nimport {\n\tDefaultHorizontalAlignStyle,\n\tTLDefaultHorizontalAlignStyle,\n} from '../styles/TLHorizontalAlignStyle'\nimport { DefaultSizeStyle, TLDefaultSizeStyle } from '../styles/TLSizeStyle'\nimport {\n\tDefaultVerticalAlignStyle,\n\tTLDefaultVerticalAlignStyle,\n} from '../styles/TLVerticalAlignStyle'\nimport { TLBaseShape } from './TLBaseShape'\n\n/**\n * Properties for a note shape. Note shapes represent sticky notes or text annotations\n * with rich formatting capabilities and various styling options.\n *\n * @public\n * @example\n * ```ts\n * const noteProps: TLNoteShapeProps = {\n *   color: 'yellow',\n *   labelColor: 'black',\n *   size: 'm',\n *   font: 'draw',\n *   fontSizeAdjustment: 0,\n *   align: 'middle',\n *   verticalAlign: 'middle',\n *   growY: 0,\n *   url: '',\n *   richText: toRichText('Hello **world**!'),\n *   scale: 1\n * }\n * ```\n */\nexport interface TLNoteShapeProps {\n\t/** Background color style of the note */\n\tcolor: TLDefaultColorStyle\n\t/** Text color style for the note content */\n\tlabelColor: TLDefaultColorStyle\n\t/** Size style determining the font size and note dimensions */\n\tsize: TLDefaultSizeStyle\n\t/** Font family style for the note text */\n\tfont: TLDefaultFontStyle\n\t/** Adjustment to the base font size (positive increases, negative decreases) */\n\tfontSizeAdjustment: number\n\t/** Horizontal alignment of text within the note */\n\talign: TLDefaultHorizontalAlignStyle\n\t/** Vertical alignment of text within the note */\n\tverticalAlign: TLDefaultVerticalAlignStyle\n\t/** Additional height growth for the note beyond its base size */\n\tgrowY: number\n\t/** Optional URL associated with the note for linking */\n\turl: string\n\t/** Rich text content with formatting like bold, italic, etc. */\n\trichText: TLRichText\n\t/** Scale factor applied to the note shape for display */\n\tscale: number\n}\n\n/**\n * A note shape representing a sticky note or text annotation on the canvas.\n * Note shapes support rich text formatting, various styling options, and can\n * be used for annotations, reminders, or general text content.\n *\n * @public\n * @example\n * ```ts\n * const noteShape: TLNoteShape = {\n *   id: 'shape:note1',\n *   type: 'note',\n *   x: 100,\n *   y: 100,\n *   rotation: 0,\n *   index: 'a1',\n *   parentId: 'page:main',\n *   isLocked: false,\n *   opacity: 1,\n *   props: {\n *     color: 'light-blue',\n *     labelColor: 'black',\n *     size: 's',\n *     font: 'sans',\n *     fontSizeAdjustment: 2,\n *     align: 'start',\n *     verticalAlign: 'start',\n *     growY: 50,\n *     url: 'https://example.com',\n *     richText: toRichText('Important **note**!'),\n *     scale: 1\n *   },\n *   meta: {},\n *   typeName: 'shape'\n * }\n * ```\n */\nexport type TLNoteShape = TLBaseShape<'note', TLNoteShapeProps>\n\n/**\n * Validation schema for note shape properties. Defines the runtime validation rules\n * for all properties of note shapes, ensuring data integrity and type safety.\n *\n * @public\n * @example\n * ```ts\n * import { noteShapeProps } from '@tldraw/tlschema'\n *\n * // Used internally by the validation system\n * const validator = T.object(noteShapeProps)\n * const validatedProps = validator.validate(someNoteProps)\n * ```\n */\nexport const noteShapeProps: RecordProps<TLNoteShape> = {\n\tcolor: DefaultColorStyle,\n\tlabelColor: DefaultLabelColorStyle,\n\tsize: DefaultSizeStyle,\n\tfont: DefaultFontStyle,\n\tfontSizeAdjustment: T.positiveNumber,\n\talign: DefaultHorizontalAlignStyle,\n\tverticalAlign: DefaultVerticalAlignStyle,\n\tgrowY: T.positiveNumber,\n\turl: T.linkUrl,\n\trichText: richTextValidator,\n\tscale: T.nonZeroNumber,\n}\n\nconst Versions = createShapePropsMigrationIds('note', {\n\tAddUrlProp: 1,\n\tRemoveJustify: 2,\n\tMigrateLegacyAlign: 3,\n\tAddVerticalAlign: 4,\n\tMakeUrlsValid: 5,\n\tAddFontSizeAdjustment: 6,\n\tAddScale: 7,\n\tAddLabelColor: 8,\n\tAddRichText: 9,\n\tAddRichTextAttrs: 10,\n})\n\n/**\n * Version identifiers for note shape migrations. These version numbers track\n * significant schema changes over time, enabling proper data migration between versions.\n *\n * @public\n */\nexport { Versions as noteShapeVersions }\n\n/**\n * Migration sequence for note shapes. Handles schema evolution over time by defining\n * how to upgrade and downgrade note shape data between different versions. Includes\n * migrations for URL properties, text alignment changes, vertical alignment addition,\n * font size adjustments, scaling support, label color, the transition from plain text to rich text,\n * and support for attrs property on richText.\n *\n * @public\n */\nexport const noteShapeMigrations = createShapePropsMigrationSequence({\n\tsequence: [\n\t\t{\n\t\t\tid: Versions.AddUrlProp,\n\t\t\tup: (props) => {\n\t\t\t\tprops.url = ''\n\t\t\t},\n\t\t\tdown: 'retired',\n\t\t},\n\t\t{\n\t\t\tid: Versions.RemoveJustify,\n\t\t\tup: (props) => {\n\t\t\t\tif (props.align === 'justify') {\n\t\t\t\t\tprops.align = 'start'\n\t\t\t\t}\n\t\t\t},\n\t\t\tdown: 'retired',\n\t\t},\n\t\t{\n\t\t\tid: Versions.MigrateLegacyAlign,\n\t\t\tup: (props) => {\n\t\t\t\tswitch (props.align) {\n\t\t\t\t\tcase 'start':\n\t\t\t\t\t\tprops.align = 'start-legacy'\n\t\t\t\t\t\treturn\n\t\t\t\t\tcase 'end':\n\t\t\t\t\t\tprops.align = 'end-legacy'\n\t\t\t\t\t\treturn\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tprops.align = 'middle-legacy'\n\t\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t},\n\t\t\tdown: 'retired',\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddVerticalAlign,\n\t\t\tup: (props) => {\n\t\t\t\tprops.verticalAlign = 'middle'\n\t\t\t},\n\t\t\tdown: 'retired',\n\t\t},\n\t\t{\n\t\t\tid: Versions.MakeUrlsValid,\n\t\t\tup: (props) => {\n\t\t\t\tif (!T.linkUrl.isValid(props.url)) {\n\t\t\t\t\tprops.url = ''\n\t\t\t\t}\n\t\t\t},\n\t\t\tdown: (_props) => {\n\t\t\t\t// noop\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddFontSizeAdjustment,\n\t\t\tup: (props) => {\n\t\t\t\tprops.fontSizeAdjustment = 0\n\t\t\t},\n\t\t\tdown: (props) => {\n\t\t\t\tdelete props.fontSizeAdjustment\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddScale,\n\t\t\tup: (props) => {\n\t\t\t\tprops.scale = 1\n\t\t\t},\n\t\t\tdown: (props) => {\n\t\t\t\tdelete props.scale\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddLabelColor,\n\t\t\tup: (props) => {\n\t\t\t\tprops.labelColor = 'black'\n\t\t\t},\n\t\t\tdown: (props) => {\n\t\t\t\tdelete props.labelColor\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddRichText,\n\t\t\tup: (props) => {\n\t\t\t\tprops.richText = toRichText(props.text)\n\t\t\t\tdelete props.text\n\t\t\t},\n\t\t\t// N.B. Explicitly no down state so that we force clients to update.\n\t\t\t// down: (props) => {\n\t\t\t// \tdelete props.richText\n\t\t\t// },\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddRichTextAttrs,\n\t\t\tup: (_props) => {\n\t\t\t\t// noop - attrs is optional so old records are valid\n\t\t\t},\n\t\t\tdown: (props) => {\n\t\t\t\t// Remove attrs from richText when migrating down\n\t\t\t\tif (props.richText && 'attrs' in props.richText) {\n\t\t\t\t\tdelete props.richText.attrs\n\t\t\t\t}\n\t\t\t},\n\t\t},\n\t],\n})\n"],
-  "mappings": "AAAA,SAAS,SAAS;AAClB,SAAqB,mBAAmB,kBAAkB;AAC1D,SAAS,8BAA8B,yCAAyC;AAEhF;AAAA,EACC;AAAA,EACA;AAAA,OAEM;AACP,SAAS,wBAA4C;AACrD;AAAA,EACC;AAAA,OAEM;AACP,SAAS,wBAA4C;AACrD;AAAA,EACC;AAAA,OAEM;AAsGA,MAAM,iBAA2C;AAAA,EACvD,OAAO;AAAA,EACP,YAAY;AAAA,EACZ,MAAM;AAAA,EACN,MAAM;AAAA,EACN,oBAAoB,EAAE;AAAA,EACtB,OAAO;AAAA,EACP,eAAe;AAAA,EACf,OAAO,EAAE;AAAA,EACT,KAAK,EAAE;AAAA,EACP,UAAU;AAAA,EACV,OAAO,EAAE;AACV;AAEA,MAAM,WAAW,6BAA6B,QAAQ;AAAA,EACrD,YAAY;AAAA,EACZ,eAAe;AAAA,EACf,oBAAoB;AAAA,EACpB,kBAAkB;AAAA,EAClB,eAAe;AAAA,EACf,uBAAuB;AAAA,EACvB,UAAU;AAAA,EACV,eAAe;AAAA,EACf,aAAa;AAAA,EACb,kBAAkB;AACnB,CAAC;AAmBM,MAAM,sBAAsB,kCAAkC;AAAA,EACpE,UAAU;AAAA,IACT;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,MAAM;AAAA,MACb;AAAA,MACA,MAAM;AAAA,IACP;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,YAAI,MAAM,UAAU,WAAW;AAC9B,gBAAM,QAAQ;AAAA,QACf;AAAA,MACD;AAAA,MACA,MAAM;AAAA,IACP;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,gBAAQ,MAAM,OAAO;AAAA,UACpB,KAAK;AACJ,kBAAM,QAAQ;AACd;AAAA,UACD,KAAK;AACJ,kBAAM,QAAQ;AACd;AAAA,UACD;AACC,kBAAM,QAAQ;AACd;AAAA,QACF;AAAA,MACD;AAAA,MACA,MAAM;AAAA,IACP;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,gBAAgB;AAAA,MACvB;AAAA,MACA,MAAM;AAAA,IACP;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,YAAI,CAAC,EAAE,QAAQ,QAAQ,MAAM,GAAG,GAAG;AAClC,gBAAM,MAAM;AAAA,QACb;AAAA,MACD;AAAA,MACA,MAAM,CAAC,WAAW;AAAA,MAElB;AAAA,IACD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,qBAAqB;AAAA,MAC5B;AAAA,MACA,MAAM,CAAC,UAAU;AAChB,eAAO,MAAM;AAAA,MACd;AAAA,IACD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,QAAQ;AAAA,MACf;AAAA,MACA,MAAM,CAAC,UAAU;AAChB,eAAO,MAAM;AAAA,MACd;AAAA,IACD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,aAAa;AAAA,MACpB;AAAA,MACA,MAAM,CAAC,UAAU;AAChB,eAAO,MAAM;AAAA,MACd;AAAA,IACD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,WAAW,WAAW,MAAM,IAAI;AACtC,eAAO,MAAM;AAAA,MACd;AAAA;AAAA;AAAA;AAAA;AAAA,IAKD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,WAAW;AAAA,MAEhB;AAAA,MACA,MAAM,CAAC,UAAU;AAEhB,YAAI,MAAM,YAAY,WAAW,MAAM,UAAU;AAChD,iBAAO,MAAM,SAAS;AAAA,QACvB;AAAA,MACD;AAAA,IACD;AAAA,EACD;AACD,CAAC;",
+  "sourcesContent": ["import { T } from '@tldraw/validate'\nimport { TLRichText, richTextValidator, toRichText } from '../misc/TLRichText'\nimport { createShapePropsMigrationIds, createShapePropsMigrationSequence } from '../records/TLShape'\nimport { RecordProps } from '../recordsWithProps'\nimport {\n\tDefaultColorStyle,\n\tDefaultLabelColorStyle,\n\tTLDefaultColorStyle,\n} from '../styles/TLColorStyle'\nimport { DefaultFontStyle, TLDefaultFontStyle } from '../styles/TLFontStyle'\nimport {\n\tDefaultHorizontalAlignStyle,\n\tTLDefaultHorizontalAlignStyle,\n} from '../styles/TLHorizontalAlignStyle'\nimport { DefaultSizeStyle, TLDefaultSizeStyle } from '../styles/TLSizeStyle'\nimport {\n\tDefaultVerticalAlignStyle,\n\tTLDefaultVerticalAlignStyle,\n} from '../styles/TLVerticalAlignStyle'\nimport { TLBaseShape } from './TLBaseShape'\n\n/**\n * Properties for a note shape. Note shapes represent sticky notes or text annotations\n * with rich formatting capabilities and various styling options.\n *\n * @public\n * @example\n * ```ts\n * const noteProps: TLNoteShapeProps = {\n *   color: 'yellow',\n *   labelColor: 'black',\n *   size: 'm',\n *   font: 'draw',\n *   fontSizeAdjustment: 0,\n *   align: 'middle',\n *   verticalAlign: 'middle',\n *   growY: 0,\n *   url: '',\n *   richText: toRichText('Hello **world**!'),\n *   scale: 1\n * }\n * ```\n */\nexport interface TLNoteShapeProps {\n\t/** Background color style of the note */\n\tcolor: TLDefaultColorStyle\n\t/** Text color style for the note content */\n\tlabelColor: TLDefaultColorStyle\n\t/** Size style determining the font size and note dimensions */\n\tsize: TLDefaultSizeStyle\n\t/** Font family style for the note text */\n\tfont: TLDefaultFontStyle\n\t/** Adjustment to the base font size (positive increases, negative decreases) */\n\tfontSizeAdjustment: number\n\t/** Horizontal alignment of text within the note */\n\talign: TLDefaultHorizontalAlignStyle\n\t/** Vertical alignment of text within the note */\n\tverticalAlign: TLDefaultVerticalAlignStyle\n\t/** Additional height growth for the note beyond its base size */\n\tgrowY: number\n\t/** Optional URL associated with the note for linking */\n\turl: string\n\t/** Rich text content with formatting like bold, italic, etc. */\n\trichText: TLRichText\n\t/** Scale factor applied to the note shape for display */\n\tscale: number\n\t/** User ID of the person who first edited the note text */\n\ttextFirstEditedBy: string | null\n}\n\n/**\n * A note shape representing a sticky note or text annotation on the canvas.\n * Note shapes support rich text formatting, various styling options, and can\n * be used for annotations, reminders, or general text content.\n *\n * @public\n * @example\n * ```ts\n * const noteShape: TLNoteShape = {\n *   id: 'shape:note1',\n *   type: 'note',\n *   x: 100,\n *   y: 100,\n *   rotation: 0,\n *   index: 'a1',\n *   parentId: 'page:main',\n *   isLocked: false,\n *   opacity: 1,\n *   props: {\n *     color: 'light-blue',\n *     labelColor: 'black',\n *     size: 's',\n *     font: 'sans',\n *     fontSizeAdjustment: 2,\n *     align: 'start',\n *     verticalAlign: 'start',\n *     growY: 50,\n *     url: 'https://example.com',\n *     richText: toRichText('Important **note**!'),\n *     scale: 1\n *   },\n *   meta: {},\n *   typeName: 'shape'\n * }\n * ```\n */\nexport type TLNoteShape = TLBaseShape<'note', TLNoteShapeProps>\n\n/**\n * Validation schema for note shape properties. Defines the runtime validation rules\n * for all properties of note shapes, ensuring data integrity and type safety.\n *\n * @public\n * @example\n * ```ts\n * import { noteShapeProps } from '@tldraw/tlschema'\n *\n * // Used internally by the validation system\n * const validator = T.object(noteShapeProps)\n * const validatedProps = validator.validate(someNoteProps)\n * ```\n */\nexport const noteShapeProps: RecordProps<TLNoteShape> = {\n\tcolor: DefaultColorStyle,\n\tlabelColor: DefaultLabelColorStyle,\n\tsize: DefaultSizeStyle,\n\tfont: DefaultFontStyle,\n\tfontSizeAdjustment: T.positiveNumber,\n\talign: DefaultHorizontalAlignStyle,\n\tverticalAlign: DefaultVerticalAlignStyle,\n\tgrowY: T.positiveNumber,\n\turl: T.linkUrl,\n\trichText: richTextValidator,\n\tscale: T.nonZeroNumber,\n\ttextFirstEditedBy: T.string.nullable(),\n}\n\nconst Versions = createShapePropsMigrationIds('note', {\n\tAddUrlProp: 1,\n\tRemoveJustify: 2,\n\tMigrateLegacyAlign: 3,\n\tAddVerticalAlign: 4,\n\tMakeUrlsValid: 5,\n\tAddFontSizeAdjustment: 6,\n\tAddScale: 7,\n\tAddLabelColor: 8,\n\tAddRichText: 9,\n\tAddRichTextAttrs: 10,\n\tAddFirstEditedBy: 11,\n})\n\n/**\n * Version identifiers for note shape migrations. These version numbers track\n * significant schema changes over time, enabling proper data migration between versions.\n *\n * @public\n */\nexport { Versions as noteShapeVersions }\n\n/**\n * Migration sequence for note shapes. Handles schema evolution over time by defining\n * how to upgrade and downgrade note shape data between different versions. Includes\n * migrations for URL properties, text alignment changes, vertical alignment addition,\n * font size adjustments, scaling support, label color, the transition from plain text to rich text,\n * and support for attrs property on richText.\n *\n * @public\n */\nexport const noteShapeMigrations = createShapePropsMigrationSequence({\n\tsequence: [\n\t\t{\n\t\t\tid: Versions.AddUrlProp,\n\t\t\tup: (props) => {\n\t\t\t\tprops.url = ''\n\t\t\t},\n\t\t\tdown: 'retired',\n\t\t},\n\t\t{\n\t\t\tid: Versions.RemoveJustify,\n\t\t\tup: (props) => {\n\t\t\t\tif (props.align === 'justify') {\n\t\t\t\t\tprops.align = 'start'\n\t\t\t\t}\n\t\t\t},\n\t\t\tdown: 'retired',\n\t\t},\n\t\t{\n\t\t\tid: Versions.MigrateLegacyAlign,\n\t\t\tup: (props) => {\n\t\t\t\tswitch (props.align) {\n\t\t\t\t\tcase 'start':\n\t\t\t\t\t\tprops.align = 'start-legacy'\n\t\t\t\t\t\treturn\n\t\t\t\t\tcase 'end':\n\t\t\t\t\t\tprops.align = 'end-legacy'\n\t\t\t\t\t\treturn\n\t\t\t\t\tdefault:\n\t\t\t\t\t\tprops.align = 'middle-legacy'\n\t\t\t\t\t\treturn\n\t\t\t\t}\n\t\t\t},\n\t\t\tdown: 'retired',\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddVerticalAlign,\n\t\t\tup: (props) => {\n\t\t\t\tprops.verticalAlign = 'middle'\n\t\t\t},\n\t\t\tdown: 'retired',\n\t\t},\n\t\t{\n\t\t\tid: Versions.MakeUrlsValid,\n\t\t\tup: (props) => {\n\t\t\t\tif (!T.linkUrl.isValid(props.url)) {\n\t\t\t\t\tprops.url = ''\n\t\t\t\t}\n\t\t\t},\n\t\t\tdown: (_props) => {\n\t\t\t\t// noop\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddFontSizeAdjustment,\n\t\t\tup: (props) => {\n\t\t\t\tprops.fontSizeAdjustment = 0\n\t\t\t},\n\t\t\tdown: (props) => {\n\t\t\t\tdelete props.fontSizeAdjustment\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddScale,\n\t\t\tup: (props) => {\n\t\t\t\tprops.scale = 1\n\t\t\t},\n\t\t\tdown: (props) => {\n\t\t\t\tdelete props.scale\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddLabelColor,\n\t\t\tup: (props) => {\n\t\t\t\tprops.labelColor = 'black'\n\t\t\t},\n\t\t\tdown: (props) => {\n\t\t\t\tdelete props.labelColor\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddRichText,\n\t\t\tup: (props) => {\n\t\t\t\tprops.richText = toRichText(props.text)\n\t\t\t\tdelete props.text\n\t\t\t},\n\t\t\t// N.B. Explicitly no down state so that we force clients to update.\n\t\t\t// down: (props) => {\n\t\t\t// \tdelete props.richText\n\t\t\t// },\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddRichTextAttrs,\n\t\t\tup: (_props) => {\n\t\t\t\t// noop - attrs is optional so old records are valid\n\t\t\t},\n\t\t\tdown: (props) => {\n\t\t\t\t// Remove attrs from richText when migrating down\n\t\t\t\tif (props.richText && 'attrs' in props.richText) {\n\t\t\t\t\tdelete props.richText.attrs\n\t\t\t\t}\n\t\t\t},\n\t\t},\n\t\t{\n\t\t\tid: Versions.AddFirstEditedBy,\n\t\t\tup: (props) => {\n\t\t\t\tprops.textFirstEditedBy = null\n\t\t\t},\n\t\t\tdown: (props) => {\n\t\t\t\tdelete props.textFirstEditedBy\n\t\t\t},\n\t\t},\n\t],\n})\n"],
+  "mappings": "AAAA,SAAS,SAAS;AAClB,SAAqB,mBAAmB,kBAAkB;AAC1D,SAAS,8BAA8B,yCAAyC;AAEhF;AAAA,EACC;AAAA,EACA;AAAA,OAEM;AACP,SAAS,wBAA4C;AACrD;AAAA,EACC;AAAA,OAEM;AACP,SAAS,wBAA4C;AACrD;AAAA,EACC;AAAA,OAEM;AAwGA,MAAM,iBAA2C;AAAA,EACvD,OAAO;AAAA,EACP,YAAY;AAAA,EACZ,MAAM;AAAA,EACN,MAAM;AAAA,EACN,oBAAoB,EAAE;AAAA,EACtB,OAAO;AAAA,EACP,eAAe;AAAA,EACf,OAAO,EAAE;AAAA,EACT,KAAK,EAAE;AAAA,EACP,UAAU;AAAA,EACV,OAAO,EAAE;AAAA,EACT,mBAAmB,EAAE,OAAO,SAAS;AACtC;AAEA,MAAM,WAAW,6BAA6B,QAAQ;AAAA,EACrD,YAAY;AAAA,EACZ,eAAe;AAAA,EACf,oBAAoB;AAAA,EACpB,kBAAkB;AAAA,EAClB,eAAe;AAAA,EACf,uBAAuB;AAAA,EACvB,UAAU;AAAA,EACV,eAAe;AAAA,EACf,aAAa;AAAA,EACb,kBAAkB;AAAA,EAClB,kBAAkB;AACnB,CAAC;AAmBM,MAAM,sBAAsB,kCAAkC;AAAA,EACpE,UAAU;AAAA,IACT;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,MAAM;AAAA,MACb;AAAA,MACA,MAAM;AAAA,IACP;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,YAAI,MAAM,UAAU,WAAW;AAC9B,gBAAM,QAAQ;AAAA,QACf;AAAA,MACD;AAAA,MACA,MAAM;AAAA,IACP;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,gBAAQ,MAAM,OAAO;AAAA,UACpB,KAAK;AACJ,kBAAM,QAAQ;AACd;AAAA,UACD,KAAK;AACJ,kBAAM,QAAQ;AACd;AAAA,UACD;AACC,kBAAM,QAAQ;AACd;AAAA,QACF;AAAA,MACD;AAAA,MACA,MAAM;AAAA,IACP;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,gBAAgB;AAAA,MACvB;AAAA,MACA,MAAM;AAAA,IACP;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,YAAI,CAAC,EAAE,QAAQ,QAAQ,MAAM,GAAG,GAAG;AAClC,gBAAM,MAAM;AAAA,QACb;AAAA,MACD;AAAA,MACA,MAAM,CAAC,WAAW;AAAA,MAElB;AAAA,IACD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,qBAAqB;AAAA,MAC5B;AAAA,MACA,MAAM,CAAC,UAAU;AAChB,eAAO,MAAM;AAAA,MACd;AAAA,IACD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,QAAQ;AAAA,MACf;AAAA,MACA,MAAM,CAAC,UAAU;AAChB,eAAO,MAAM;AAAA,MACd;AAAA,IACD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,aAAa;AAAA,MACpB;AAAA,MACA,MAAM,CAAC,UAAU;AAChB,eAAO,MAAM;AAAA,MACd;AAAA,IACD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,WAAW,WAAW,MAAM,IAAI;AACtC,eAAO,MAAM;AAAA,MACd;AAAA;AAAA;AAAA;AAAA;AAAA,IAKD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,WAAW;AAAA,MAEhB;AAAA,MACA,MAAM,CAAC,UAAU;AAEhB,YAAI,MAAM,YAAY,WAAW,MAAM,UAAU;AAChD,iBAAO,MAAM,SAAS;AAAA,QACvB;AAAA,MACD;AAAA,IACD;AAAA,IACA;AAAA,MACC,IAAI,SAAS;AAAA,MACb,IAAI,CAAC,UAAU;AACd,cAAM,oBAAoB;AAAA,MAC3B;AAAA,MACA,MAAM,CAAC,UAAU;AAChB,eAAO,MAAM;AAAA,MACd;AAAA,IACD;AAAA,EACD;AACD,CAAC;",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tldraw/tlschema",
   "description": "tldraw infinite canvas SDK (schema).",
-  "version": "4.6.0-next.1f489710ee41",
+  "version": "4.6.0-next.4dde09fa17ab",
   "author": {
     "name": "tldraw Inc.",
     "email": "hello@tldraw.com"
@@ -41,7 +41,7 @@
     "prepack": "yarn run -T tsx ../../internal/scripts/prepack.ts",
     "postpack": "../../internal/scripts/postpack.sh",
     "pack-tarball": "yarn pack",
-    "lint": "cd ../.. && yarn run -T oxlint packages/tlschema"
+    "lint": "yarn run -T tsx ../../internal/scripts/lint.ts"
   },
   "devDependencies": {
     "kleur": "^4.1.5",
@@ -50,10 +50,10 @@
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "@tldraw/state": "4.6.0-next.1f489710ee41",
-    "@tldraw/store": "4.6.0-next.1f489710ee41",
-    "@tldraw/utils": "4.6.0-next.1f489710ee41",
-    "@tldraw/validate": "4.6.0-next.1f489710ee41"
+    "@tldraw/state": "4.6.0-next.4dde09fa17ab",
+    "@tldraw/store": "4.6.0-next.4dde09fa17ab",
+    "@tldraw/utils": "4.6.0-next.4dde09fa17ab",
+    "@tldraw/validate": "4.6.0-next.4dde09fa17ab"
   },
   "peerDependencies": {
     "react": "^18.2.0 || ^19.2.1",

package/src/TLStore.test.ts

@@ -1,3 +1,4 @@
+import { computed } from '@tldraw/state'
 import { Store } from '@tldraw/store'
 import { annotateError, IndexKey, structuredClone } from '@tldraw/utils'
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
@@ -330,6 +331,10 @@ describe('createIntegrityChecker', () => {
 			props: {
 				defaultName: 'Test Store',
 				assets: mockAssetStore,
+				users: {
+					currentUser: computed('currentUser', () => null),
+					resolve: () => computed('resolve', () => null),
+				},
 				onMount: vi.fn(),
 			},
 		})

package/src/TLStore.ts

@@ -1,4 +1,4 @@
-import { Signal } from '@tldraw/state'
+import { Signal, computed } from '@tldraw/state'
 import {
 	SerializedStore,
 	Store,
@@ -15,6 +15,7 @@ import { PageRecordType, TLPageId } from './records/TLPage'
 import { InstancePageStateRecordType, TLInstancePageStateId } from './records/TLPageState'
 import { PointerRecordType, TLPOINTER_ID } from './records/TLPointer'
 import { TLRecord } from './records/TLRecord'
+import { TLUser } from './records/TLUser'
 
 /**
  * Redacts the source of an asset record for error reporting.
@@ -200,6 +201,97 @@ export interface TLAssetStore {
 	remove?(assetIds: TLAssetId[]): Promise<void>
 }
 
+/**
+ * Interface for resolving user information in tldraw.
+ *
+ * A `TLUserStore` sits alongside the main {@link TLStore} and provides user
+ * resolution for attribution labels and display names. Implement this interface
+ * to connect tldraw to your auth/user system.
+ *
+ * `currentUser` and `resolve` are reactive {@link @tldraw/state#Signal | Signals}
+ * so that the editor can automatically track changes to user data and
+ * re-render when a user's name, color, or avatar updates.
+ *
+ * Implementations should cache signals returned by `resolve` — e.g. return the
+ * same `Signal` for repeated calls with the same `userId` — to avoid
+ * unnecessary re-computation.
+ *
+ * @public
+ * @example
+ * ```ts
+ * const currentUser = computed('currentUser', () =>
+ *   UserRecordType.create({
+ *     id: createUserId(myAuth.userId),
+ *     name: myAuth.displayName,
+ *     color: myAuth.color,
+ *   })
+ * )
+ *
+ * const userStore: TLUserStore = {
+ *   currentUser,
+ *   resolve(userId) {
+ *     return computed('resolve-' + userId, () =>
+ *       myUserCache.get(userId) ?? null
+ *     )
+ *   },
+ * }
+ * ```
+ */
+export interface TLUserStore {
+	/**
+	 * A signal resolving to the currently authenticated user,
+	 * or `null` for anonymous / unknown.
+	 * Read when stamping attribution on shape create/update.
+	 */
+	currentUser: Signal<TLUser | null>
+
+	/**
+	 * Return a signal resolving an arbitrary user ID to display info.
+	 * Called when rendering attribution labels for shapes that may have been
+	 * created or edited by someone else.
+	 * The signal's value should be `null` if the user cannot be resolved.
+	 */
+	resolve?(userId: string): Signal<TLUser | null>
+}
+
+/**
+ * Create a cached {@link TLUserStore.resolve} implementation.
+ *
+ * Wraps a reactive lookup function so that each `userId` gets a single
+ * stable {@link @tldraw/state#Signal | Signal} that is reused across calls.
+ * The `resolveFn` is evaluated inside a `computed`, so any `.get()` calls
+ * it makes are automatically tracked.
+ *
+ * @param resolveFn - A function that resolves a raw user-ID string to a
+ *   {@link TLUser} or `null`. Called reactively inside a `computed`.
+ * @returns A function suitable for use as `TLUserStore.resolve`.
+ *
+ * @example
+ * ```ts
+ * const users: TLUserStore = {
+ *   currentUser: currentUserSignal,
+ *   resolve: createCachedUserResolve(
+ *     (userId) => usersAtom.get()[createUserId(userId)] ?? null
+ *   ),
+ * }
+ * ```
+ *
+ * @public
+ */
+export function createCachedUserResolve(
+	resolveFn: (userId: string) => TLUser | null
+): (userId: string) => Signal<TLUser | null> {
+	const cache = new Map<string, Signal<TLUser | null>>()
+	return (userId: string) => {
+		let signal = cache.get(userId)
+		if (!signal) {
+			signal = computed('resolve-user-' + userId, () => resolveFn(userId))
+			cache.set(userId, signal)
+		}
+		return signal
+	}
+}
+
 /**
  * Configuration properties for a tldraw store, defining its behavior and integrations.
  * These props are passed when creating a new store instance.
@@ -228,6 +320,8 @@ export interface TLStoreProps {
 	defaultName: string
 	/** Asset store implementation for handling file uploads and storage */
 	assets: Required<TLAssetStore>
+	/** User store implementation for user resolution and attribution */
+	users: Required<TLUserStore>
 	/**
 	 * Called when an {@link @tldraw/editor#Editor} connected to this store is mounted.
 	 * Can optionally return a cleanup function that will be called when unmounted.

package/src/createPresenceStateDerivation.test.ts

@@ -1,21 +1,21 @@
-import { atom } from '@tldraw/state'
+import { atom, computed } from '@tldraw/state'
 import { Store } from '@tldraw/store'
 import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
 import {
 	createPresenceStateDerivation,
 	getDefaultUserPresence,
-	TLPresenceUserInfo,
 } from './createPresenceStateDerivation'
 import { createTLSchema } from './createTLSchema'
 import { TLINSTANCE_ID } from './records/TLInstance'
 import { TLPageId } from './records/TLPage'
 import { InstancePageStateRecordType } from './records/TLPageState'
 import { TLRecord } from './records/TLRecord'
+import { createUserId, TLUser, UserRecordType } from './records/TLUser'
 import { createIntegrityChecker, TLStoreProps } from './TLStore'
 
 describe('createPresenceStateDerivation', () => {
 	let store: Store<TLRecord, TLStoreProps>
-	let userSignal: ReturnType<typeof atom<TLPresenceUserInfo>>
+	let userSignal: ReturnType<typeof atom<TLUser>>
 
 	beforeEach(() => {
 		const schema = createTLSchema()
@@ -28,6 +28,10 @@ describe('createPresenceStateDerivation', () => {
 					resolve: vi.fn().mockResolvedValue('resolved-url'),
 					remove: vi.fn().mockResolvedValue(undefined),
 				},
+				users: {
+					currentUser: computed('currentUser', () => null),
+					resolve: () => computed('resolve', () => null),
+				},
 				onMount: vi.fn(),
 			},
 		})
@@ -36,11 +40,14 @@ describe('createPresenceStateDerivation', () => {
 		const checker = createIntegrityChecker(store)
 		checker()
 
-		userSignal = atom('user', {
-			id: 'user123',
-			name: 'Test User',
-			color: '#007AFF',
-		})
+		userSignal = atom(
+			'user',
+			UserRecordType.create({
+				id: createUserId('user123'),
+				name: 'Test User',
+				color: '#007AFF',
+			})
+		)
 	})
 
 	afterEach(() => {
@@ -53,16 +60,18 @@ describe('createPresenceStateDerivation', () => {
 			const presenceSignal = derivation(store)
 			const presence = presenceSignal.get()
 
-			expect(presence!.userId).toBe('user123')
+			expect(presence!.userId).toBe('user:user123')
 			expect(presence!.userName).toBe('Test User')
 			expect(presence!.color).toBe('#007AFF')
 
 			// Update user signal
-			userSignal.set({
-				id: 'user456',
-				name: 'Updated User',
-				color: '#FF6B6B',
-			})
+			userSignal.set(
+				UserRecordType.create({
+					id: createUserId('user456'),
+					name: 'Updated User',
+					color: '#FF6B6B',
+				})
+			)
 
 			const updatedPresence = presenceSignal.get()
 			expect(updatedPresence!.userName).toBe('Updated User')
@@ -111,6 +120,10 @@ describe('getDefaultUserPresence', () => {
 					resolve: vi.fn().mockResolvedValue('resolved-url'),
 					remove: vi.fn().mockResolvedValue(undefined),
 				},
+				users: {
+					currentUser: computed('currentUser', () => null),
+					resolve: () => computed('resolve', () => null),
+				},
 				onMount: vi.fn(),
 			},
 		})
@@ -126,21 +139,21 @@ describe('getDefaultUserPresence', () => {
 
 	describe('basic functionality', () => {
 		it('should return presence state with user info and default values', () => {
-			const user: TLPresenceUserInfo = {
-				id: 'test-user',
+			const user = UserRecordType.create({
+				id: createUserId('test-user'),
 				name: 'Test User',
 				color: '#00FF00',
-			}
+			})
 
 			const presence = getDefaultUserPresence(store, user)
 
-			expect(presence!.userId).toBe('test-user')
+			expect(presence!.userId).toBe('user:test-user')
 			expect(presence!.userName).toBe('Test User')
 			expect(presence!.color).toBe('#00FF00')
 		})
 
 		it('should use defaults for missing user fields', () => {
-			const minimalUser: TLPresenceUserInfo = { id: 'minimal' }
+			const minimalUser = UserRecordType.create({ id: createUserId('minimal') })
 			const presence = getDefaultUserPresence(store, minimalUser)
 
 			expect(presence!.userName).toBe('')
@@ -151,7 +164,7 @@ describe('getDefaultUserPresence', () => {
 	describe('error conditions', () => {
 		it('should return null when required records are missing', () => {
 			store.remove([TLINSTANCE_ID])
-			const user: TLPresenceUserInfo = { id: 'test' }
+			const user = UserRecordType.create({ id: createUserId('test') })
 			expect(getDefaultUserPresence(store, user)).toBe(null)
 		})
 	})

package/src/createPresenceStateDerivation.ts

@@ -4,25 +4,18 @@ import { TLINSTANCE_ID } from './records/TLInstance'
 import { InstancePageStateRecordType } from './records/TLPageState'
 import { TLPOINTER_ID } from './records/TLPointer'
 import { InstancePresenceRecordType, TLInstancePresence } from './records/TLPresence'
+import { TLUser } from './records/TLUser'
 import { TLStore } from './TLStore'
 
-/**
- * The information about a user which is used for multiplayer features.
- * @public
- */
-export interface TLPresenceUserInfo {
-	/**
-	 * id - A unique identifier for the user. This should be the same across all devices and sessions.
-	 */
-	id: string
-	/**
-	 * The user's display name.
-	 */
-	name?: string | null
+/** @public */
+export interface CreatePresenceStateDerivationOpts {
+	/** Custom instance ID. If not provided, one is generated from the store ID. */
+	instanceId?: TLInstancePresence['id']
 	/**
-	 * The user's color. If not given, a random color will be assigned.
+	 * Override how presence state is built from the store and current user.
+	 * Defaults to {@link getDefaultUserPresence}.
 	 */
-	color?: string | null
+	getUserPresence?(store: TLStore, user: TLUser): TLPresenceStateInfo | null
 }
 
 /**
@@ -33,8 +26,8 @@ export interface TLPresenceUserInfo {
  * position, selected shapes, camera position, and user metadata that gets synchronized in
  * multiplayer scenarios.
  *
- * @param $user - A reactive signal containing the user information
- * @param instanceId - Optional custom instance ID. If not provided, one will be generated based on the store ID
+ * @param $user - A reactive signal containing the user information, or `null` when anonymous
+ * @param opts - Optional configuration for instance ID and presence derivation
  * @returns A function that takes a store and returns a computed signal of the user's presence state
  *
  * @example
@@ -42,7 +35,7 @@ export interface TLPresenceUserInfo {
  * import { createPresenceStateDerivation } from '@tldraw/tlschema'
  * import { atom } from '@tldraw/state'
  *
- * const userSignal = atom('user', { id: 'user-123', name: 'Alice', color: '#ff0000' })
+ * const userSignal = atom('user', { id: 'user-123', name: 'Alice', color: '#ff0000', meta: {} })
  * const presenceDerivation = createPresenceStateDerivation(userSignal)
  *
  * // Use with a store to get reactive presence state
@@ -53,15 +46,17 @@ export interface TLPresenceUserInfo {
  * @public
  */
 export function createPresenceStateDerivation(
-	$user: Signal<TLPresenceUserInfo>,
-	instanceId?: TLInstancePresence['id']
+	$user: Signal<TLUser | null>,
+	opts?: CreatePresenceStateDerivationOpts
 ) {
+	const { instanceId, getUserPresence: _getUserPresence } = opts ?? {}
+	const getUserPresence = _getUserPresence ?? getDefaultUserPresence
 	return (store: TLStore): Signal<TLInstancePresence | null> => {
 		return computed('instancePresence', () => {
 			const user = $user.get()
 			if (!user) return null
 
-			const state = getDefaultUserPresence(store, user)
+			const state = getUserPresence(store, user)
 			if (!state) return null
 
 			return InstancePresenceRecordType.create({
@@ -98,7 +93,7 @@ export type TLPresenceStateInfo = Parameters<(typeof InstancePresenceRecordType)
  * ```ts
  * import { getDefaultUserPresence } from '@tldraw/tlschema'
  *
- * const user = { id: 'user-123', name: 'Alice', color: '#ff0000' }
+ * const user = { id: 'user-123', name: 'Alice', color: '#ff0000', meta: {} }
  * const presenceInfo = getDefaultUserPresence(store, user)
  *
  * if (presenceInfo) {
@@ -122,7 +117,7 @@ export type TLPresenceStateInfo = Parameters<(typeof InstancePresenceRecordType)
  *
  * @public
  */
-export function getDefaultUserPresence(store: TLStore, user: TLPresenceUserInfo) {
+export function getDefaultUserPresence(store: TLStore, user: TLUser) {
 	const instance = store.get(TLINSTANCE_ID)
 	const pageState = store.get(InstancePageStateRecordType.createId(instance?.currentPageId))
 	const camera = store.get(CameraRecordType.createId(instance?.currentPageId))
@@ -136,14 +131,14 @@ export function getDefaultUserPresence(store: TLStore, user: TLPresenceUserInfo)
 		brush: instance.brush,
 		scribbles: instance.scribbles,
 		userId: user.id,
-		userName: user.name ?? '',
+		userName: user.name,
 		followingUserId: instance.followingUserId,
 		camera: {
 			x: camera.x,
 			y: camera.y,
 			z: camera.z,
 		},
-		color: user.color ?? '#FF0000',
+		color: user.color || '#FF0000',
 		currentPageId: instance.currentPageId,
 		cursor: {
 			x: pointer.x,

package/src/createTLSchema.ts

@@ -1,5 +1,6 @@
 import { LegacyMigrations, MigrationSequence, StoreSchema, StoreValidator } from '@tldraw/store'
 import { objectMapValues } from '@tldraw/utils'
+import { T } from '@tldraw/validate'
 import { bookmarkAssetMigrations } from './assets/TLBookmarkAsset'
 import { imageAssetMigrations } from './assets/TLImageAsset'
 import { videoAssetMigrations } from './assets/TLVideoAsset'
@@ -26,6 +27,7 @@ import {
 	getShapePropKeysByStyle,
 	rootShapeMigrations,
 } from './records/TLShape'
+import { UserRecordType, createUserRecordType, userMigrations } from './records/TLUser'
 import { RecordProps, TLPropsMigrations, processPropsMigrations } from './recordsWithProps'
 import { arrowShapeMigrations, arrowShapeProps } from './shapes/TLArrowShape'
 import { TLBaseShape } from './shapes/TLBaseShape'
@@ -193,6 +195,38 @@ export const defaultBindingSchemas = {
 	arrow: { migrations: arrowBindingMigrations, props: arrowBindingProps },
 } satisfies { [T in TLDefaultBinding['type']]: SchemaPropsInfo }
 
+/**
+ * Configuration for extending the user record type with custom metadata
+ * validators and migration sequences.
+ *
+ * @example
+ * ```ts
+ * import { T } from '@tldraw/validate'
+ *
+ * const userSchema: UserSchemaInfo = {
+ *   meta: {
+ *     isAdmin: T.boolean,
+ *     department: T.string,
+ *   },
+ * }
+ * ```
+ *
+ * @public
+ */
+export interface UserSchemaInfo {
+	/**
+	 * Validators for custom metadata fields on user records. Each field is
+	 * treated as optional — user records without these fields remain valid,
+	 * but when present, values are validated against the provided validators.
+	 */
+	meta?: Record<string, T.Validatable<any>>
+
+	/**
+	 * Additional migration sequences for evolving custom user data over time.
+	 */
+	migrations?: readonly MigrationSequence[]
+}
+
 /**
  * Creates a complete TLSchema for use with tldraw stores. This schema defines the structure,
  * validation, and migration sequences for all record types in a tldraw application.
@@ -204,6 +238,7 @@ export const defaultBindingSchemas = {
  * @param options - Configuration options for the schema
  *   - shapes - Shape schema configurations. Defaults to defaultShapeSchemas if not provided
  *   - bindings - Binding schema configurations. Defaults to defaultBindingSchemas if not provided
+ *   - user - Custom user record configuration with meta validators and migrations
  *   - records - Custom record type configurations. These are additional record types beyond
  *     the built-in shapes, bindings, assets, etc.
  *   - migrations - Additional migration sequences to include in the schema
@@ -229,6 +264,16 @@ export const defaultBindingSchemas = {
  *   },
  * })
  *
+ * // Create schema with custom user metadata
+ * const schemaWithCustomUser = createTLSchema({
+ *   user: {
+ *     meta: {
+ *       isAdmin: T.boolean,
+ *       department: T.string,
+ *     },
+ *   },
+ * })
+ *
  * // Create schema with custom record types
  * const schemaWithCustomRecords = createTLSchema({
  *   records: {
@@ -256,11 +301,13 @@ export const defaultBindingSchemas = {
 export function createTLSchema({
 	shapes = defaultShapeSchemas,
 	bindings = defaultBindingSchemas,
+	user,
 	records = {},
 	migrations,
 }: {
 	shapes?: Record<string, SchemaPropsInfo>
 	bindings?: Record<string, SchemaPropsInfo>
+	user?: UserSchemaInfo
 	records?: Record<string, CustomRecordInfo>
 	migrations?: readonly MigrationSequence[]
 } = {}): TLSchema {
@@ -277,6 +324,7 @@ export function createTLSchema({
 	const ShapeRecordType = createShapeRecordType(shapes)
 	const BindingRecordType = createBindingRecordType(bindings)
 	const InstanceRecordType = createInstanceRecordType(stylesById)
+	const CustomUserRecordType = user ? createUserRecordType(user) : UserRecordType
 
 	// Create RecordTypes for custom records
 	const builtInTypeNames = new Set([
@@ -291,6 +339,7 @@ export function createTLSchema({
 		'pointer',
 		'shape',
 		'store',
+		'user',
 	])
 	const customRecordTypes: Record<string, { createId: any }> = {}
 	for (const [typeName, config] of Object.entries(records)) {
@@ -314,6 +363,7 @@ export function createTLSchema({
 			instance_presence: InstancePresenceRecordType,
 			pointer: PointerRecordType,
 			shape: ShapeRecordType,
+			user: CustomUserRecordType,
 			...customRecordTypes,
 		},
 		{
@@ -329,6 +379,7 @@ export function createTLSchema({
 				pointerMigrations,
 				rootShapeMigrations,
 
+				userMigrations,
 				bookmarkAssetMigrations,
 				imageAssetMigrations,
 				videoAssetMigrations,
@@ -337,6 +388,7 @@ export function createTLSchema({
 				...processPropsMigrations<TLBinding>('binding', bindings),
 				...processCustomRecordMigrations(records),
 
+				...(user?.migrations ?? []),
 				...(migrations ?? []),
 			],
 			onValidationFailure,

package/src/index.ts

@@ -51,8 +51,8 @@ export {
 export {
 	createPresenceStateDerivation,
 	getDefaultUserPresence,
+	type CreatePresenceStateDerivationOpts,
 	type TLPresenceStateInfo,
-	type TLPresenceUserInfo,
 } from './createPresenceStateDerivation'
 export {
 	createTLSchema,
@@ -60,6 +60,7 @@ export {
 	defaultShapeSchemas,
 	type SchemaPropsInfo,
 	type TLSchema,
+	type UserSchemaInfo,
 } from './createTLSchema'
 export {
 	boxModelValidator,
@@ -173,6 +174,15 @@ export {
 	type TLShapePartial,
 	type TLUnknownShape,
 } from './records/TLShape'
+export {
+	createUserId,
+	createUserRecordType,
+	isUserId,
+	userIdValidator,
+	UserRecordType,
+	type TLUser,
+	type TLUserId,
+} from './records/TLUser'
 export {
 	type RecordProps,
 	type RecordPropsType,
@@ -308,6 +318,7 @@ export {
 	type TLDefaultVerticalAlignStyle,
 } from './styles/TLVerticalAlignStyle'
 export {
+	createCachedUserResolve,
 	type TLAssetContext,
 	type TLAssetStore,
 	type TLSerializedStore,
@@ -315,6 +326,7 @@ export {
 	type TLStoreProps,
 	type TLStoreSchema,
 	type TLStoreSnapshot,
+	type TLUserStore,
 } from './TLStore'
 export {
 	getDefaultTranslationLocale,