History

alex d85aac58b3 Explicitly type shape props and defaults (#4191 ) We rely on type inference for our `defaultX` types, as well as for our shape prop types. This works well and means we only have to list shape props once, but has some drawbacks: - It's unstable, which sometimes produces unintended api-report.md diffs that need to be worked around - It's not good for docs This diff makes those declared explicitly ### Change type - [x] `api` ### Release notes - Explicitly declare type types of default shapes etc. and shape props for better documentation		2024-07-16 13:16:39 +00:00
..
src	Explicitly type shape props and defaults (#4191 )	2024-07-16 13:16:39 +00:00
api-extractor.json	transfer-out: transfer out	2023-04-25 12:01:25 +01:00
api-report.md	Explicitly type shape props and defaults (#4191 )	2024-07-16 13:16:39 +00:00
CHANGELOG.md	Update CHANGELOG.md [skip ci]	2024-06-25 13:27:57 +00:00
LICENSE.md	Change licenses to tldraw (#2167 )	2023-12-19 10:41:01 +00:00
package.json	Update CHANGELOG.md [skip ci]	2024-06-25 13:27:57 +00:00
README.md	Update READMEs, add form link (#3741 )	2024-05-12 20:48:07 +00:00
tsconfig.json	Check tsconfig "references" arrays (#2891 )	2024-02-21 13:07:53 +00:00

README.md

@tldraw/tlschema

This package houses type definitions, schema migrations, and other type metadata for the tldraw editor's default persisted data.

There are three main kinds of types:

Record types

These are root record types added to the Store class. They are defined in the ./src/records directory.
Shape types

These are subtypes of the root TLShape record type. They allow specifying a unique name and custom props for a particular kind of shape.
Asset types

These are subtypes of the root TLAsset record type. They allow specifying a unique name and custom props for a particular kind of asset.

Adding migrations

If you make any kind of change to any persisted data shape in this package, you must add migrations that are able to convert old versions to new versions, and vice-versa.

If you are making a change that affects the structure of a record, shape, or asset, update the migrations in the same file as the record, shape, or asset is defined.

If you are making a change that affects the structure of the store (e.g. renaming or deleting a type, consolidating two shape types into one, etc), add your changes in the migrations in schema.ts.

After making your changes, add a new version number, using a meaninful name. For example, if you add a new property to the TLShape type called ownerId that points to a user, you might do this:

In TLShape.ts

 const Versions = {
   RemoveSomeProp: 1,
+  AddOwnerId: 2,
 } as const

and then in the TLShape type

   x: number
   y: number
+  ownerId: ID<TLUser> | null
   props: Props
   parentId: ID<TLShape> | ID<TLPage>

and then adding a migration:

 export const shapeTypeMigrations = defineMigrations({
   currentVersion: Versions.Initial,
   firstVersion: Versions.Initial,
   migrators: {
+    [Versions.AddOwnerId]: {
+      // add ownerId property
+      up: (shape) => ({...shape, ownerId: null}),
+      // remove ownerId property
+      down: ({ownerId, ...shape}) => shape,
+    }
   },

After you've added your migration, make sure to add a test for it in src/migrations.test.ts. It will complain if you do not!

Distributions

You can find tldraw on npm here.

Contribution

Please see our contributing guide. Found a bug? Please submit an issue.

License

The tldraw source code and its distributions are provided under the tldraw license. This license does not permit commercial use. To purchase a commercial license or learn more, please fill out this form.

Trademarks

Contact

Find us on Twitter/X at @tldraw.

Community

Have questions, comments or feedback? Join our discord or start a discussion. For the latest news and release notes, check out our Substack.