22 KiB
v2.2.0 (Tue Jun 11 2024)
Release Notes
Snapshots pit of success (#3811)
- Add a brief release note for your PR here.
focus: rework and untangle existing focus management logic in the sdk (#3718)
- Focus: rework and untangle existing focus management logic in the SDK
Store-level "operation end" event (#3748)
Breaking changes
editor.registerBatchCompleteHandler
has been replaced with editor.registerOperationCompleteHandler
Move arrow helpers from editor to tldraw (#3721)
Breaking changes
editor.getArrowInfo(shape)
has been replaced withgetArrowInfo(editor, shape)
editor.getArrowsBoundTo(shape)
has been removed. Instead, useeditor.getBindingsToShape(shape, 'arrow')
and follow thefromId
of each binding to the corresponding arrow shape- These types have moved from
@tldraw/editor
totldraw
:TLArcInfo
TLArrowInfo
TLArrowPoint
WeakMapCache
has been removed
Bindings (#3326)
Breaking changes
- The
start
andend
properties onTLArrowShape
no longer havetype: point | binding
. Instead, they're always a point, which may be out of date if a binding exists. To check for & retrieve arrow bindings, usegetArrowBindings(editor, shape)
instead. getArrowTerminalsInArrowSpace
must be passed aTLArrowBindings
as a third argument:getArrowTerminalsInArrowSpace(editor, shape, getArrowBindings(editor, shape))
- The following types have been renamed:
ShapeProps
->RecordProps
ShapePropsType
->RecordPropsType
TLShapePropsMigrations
->TLPropsMigrations
SchemaShapeInfo
->SchemaPropsInfo
📚 SDK Changes
- Add return info to StoreSideEffects methods #3918 (@steveruizok)
- Snapshots pit of success #3811 (@ds300)
- Force
interface
instead oftype
for better docs #3815 (@SomeHats) - focus: rework and untangle existing focus management logic in the sdk #3718 (@mimecuvalo)
- Store-level "operation end" event #3748 (@SomeHats)
- Move arrow helpers from editor to tldraw #3721 (@SomeHats)
- Bindings #3326 (@SomeHats)
- Automatic undo/redo #3364 (@SomeHats)
📖 Documentation changes
🏠 Internal
Authors: 4
- alex (@SomeHats)
- David Sheldrick (@ds300)
- Mime Čuvalo (@mimecuvalo)
- Steve Ruiz (@steveruizok)
v2.1.0 (Tue Apr 23 2024)
Release Notes
New migrations again (#3220)
BREAKING CHANGES
-
The
Migrations
type is now calledLegacyMigrations
. -
The serialized schema format (e.g. returned by
StoreSchema.serialize()
andStore.getSnapshot()
) has changed. You don't need to do anything about it unless you were reading data directly from the schema for some reason. In which case it'd be best to avoid that in the future! We have no plans to change the schema format again (this time was traumatic enough) but you never know. -
compareRecordVersions
and theRecordVersion
type have both disappeared. There is no replacement. These were public by mistake anyway, so hopefully nobody had been using it. -
compareSchemas
is gone. Comparing the schemas directly is no longer really possible since we introduced some fuzziness. The best thing to do now to check compatibility is to callschema.getMigraitonsSince(prevSchema)
and it will return an error if the schemas are not compatible, an empty array if there are no migrations to apply since the prev schema, and a nonempty array otherwise.Generally speaking, the best way to check schema compatibility now is to call
store.schema.getMigrationsSince(persistedSchema)
. This will throw an error if there is no upgrade path from thepersistedSchema
to the current version. -
defineMigrations
has been deprecated and will be removed in a future release. For upgrade instructions see https://tldraw.dev/docs/persistence#Updating-legacy-shape-migrations-defineMigrations -
migrate
has been removed. Nobody should have been using this but if you were you'll need to find an alternative. For migrating tldraw data, you should stick to usingschema.migrateStoreSnapshot
and, if you are building a nuanced sync engine that supports some amount of backwards compatibility, also feel free to useschema.migratePersistedRecord
. -
the
Migration
type has changed. If you need the old one for some reason it has been renamed toLegacyMigration
. It will be removed in a future release. -
the
Migrations
type has been renamed toLegacyMigrations
and will be removed in a future release. -
the
SerializedSchema
type has been augmented. If you need the old version specifically you can useSerializedSchemaV1
Perf: (slightly) faster min dist checks (#3401)
- Performance: small improvements to hit testing.
Don't double squash (#3182)
- Minor improvement when modifying multiple shapes at once.
Performance improvements (#2977)
- Improves the performance of rendering.
💥 Breaking Change
- Performance improvements #2977 (@MitjaBezensek @steveruizok)
📚 SDK Changes
- New migrations again #3220 (@ds300 @steveruizok)
- undo devFreeze unintentional commit #3466 (@mimecuvalo)
- Improve hand dragging with long press #3432 (@steveruizok)
- Perf: (slightly) faster min dist checks #3401 (@steveruizok)
- Fix typo. #3306 (@MitjaBezensek)
- Don't double squash #3182 (@steveruizok)
- use native structuredClone on node, cloudflare workers, and in tests #3166 (@si14)
📖 Documentation changes
- Fix typo in Store.ts #3385 (@OrionReed)
Authors: 6
- Dan Groshev (@si14)
- David Sheldrick (@ds300)
- Mime Čuvalo (@mimecuvalo)
- Mitja Bezenšek (@MitjaBezensek)
- Orion Reed (@OrionReed)
- Steve Ruiz (@steveruizok)
v2.0.0-beta.5 (Thu Feb 29 2024)
🔩 Dependency Updates
- bump typescript / api-extractor #2949 (@steveruizok)
Authors: 1
- Steve Ruiz (@steveruizok)
v2.0.0-beta.4 (Wed Feb 21 2024)
Release Notes
Faster validations + record reference stability at the same time (#2848)
- Add a brief release note for your PR here.
🐛 Bug Fix
🏠 Internal
- Check tsconfig "references" arrays #2891 (@ds300)
- dev: swap yarn test and test-dev for better dx #2773 (@mimecuvalo)
Authors: 2
- David Sheldrick (@ds300)
- Mime Čuvalo (@mimecuvalo)
v2.0.0-beta.3 (Tue Feb 13 2024)
Release Notes
dev: add test-dev command for easier testing of packages (#2627)
- Adds easier testing command for individual packages.
🚀 Enhancement
🏠 Internal
- Unbiome #2776 (@si14)
- Update the project to Node 20 #2691 (@si14)
- make CI check for yarn install warnings and fix the peer deps ones we have #2683 (@si14)
- dev: add test-dev command for easier testing of packages #2627 (@mimecuvalo)
- unbrivate, dot com in #2475 (@steveruizok @si14 @SomeHats)
- Add docs #2470 (@steveruizok)
🧪 Tests
- Bump jest to fix weird prettier bug #2716 (@steveruizok)
🔩 Dependency Updates
Authors: 4
- alex (@SomeHats)
- Dan Groshev (@si14)
- Mime Čuvalo (@mimecuvalo)
- Steve Ruiz (@steveruizok)
v2.0.0-beta.2 (Wed Jan 10 2024)
🐛 Bug Fix
- Fix meta examples #2379 (@steveruizok)
Authors: 1
- Steve Ruiz (@steveruizok)
v2.0.0-beta.1 (Wed Dec 20 2023)
Release Notes
Prevent diff mutation (#2336)
- Fix
squashRecordDiffs
to prevent a bug where it mutates the 'updated' entires
💥 Breaking Change
- bump to beta #2364 (@steveruizok)
- Change licenses to tldraw #2167 (@steveruizok)
🐛 Bug Fix
Authors: 2
- David Sheldrick (@ds300)
- Steve Ruiz (@steveruizok)
v2.0.0-alpha.19 (Tue Dec 12 2023)
💥 Breaking Change
- No impure getters pt 1 #2189 (@steveruizok @ds300)
🐛 Bug Fix
Authors: 2
- David Sheldrick (@ds300)
- Steve Ruiz (@steveruizok)
v2.0.0-alpha.18 (Fri Nov 10 2023)
🏠 Internal
- Revert "bump prerelease from alpha to beta" #2192 (@ds300)
- bump prerelease from alpha to beta #2148 (@ds300)
Authors: 1
- David Sheldrick (@ds300)
v2.0.0-alpha.17 (Tue Oct 17 2023)
🔩 Dependency Updates
Authors: 1
- David Sheldrick (@ds300)
v2.0.0-alpha.16 (Wed Oct 11 2023)
🏠 Internal
- Publish api.json #2034 (@steveruizok)
Authors: 1
- Steve Ruiz (@steveruizok)
v2.0.0-alpha.15 (Fri Oct 06 2023)
Release Notes
Fix shape drag perf (#1932)
- Fixes a perf regression for dragging shapes around
Migrate snapshot (#1843)
- [editor] add
Store.migrateSnapshot
Editor commands API / effects (#1778)
- tbd
tldraw zero - package shuffle (#1710)
- [@tldraw/editor] lots, wip
- [@tldraw/ui] gone, merged to tldraw/tldraw
- [@tldraw/polyfills] gone, merged to tldraw/editor
- [@tldraw/primitives] gone, merged to tldraw/editor / tldraw/tldraw
- [@tldraw/indices] gone, merged to tldraw/editor
- [@tldraw/file-format] gone, merged to tldraw/tldraw
💥 Breaking Change
- SideEffectManager #1785 (@steveruizok)
- Revert "Editor commands API / effects" #1783 (@steveruizok)
- Editor commands API / effects #1778 (@steveruizok)
- tldraw zero - package shuffle #1710 (@steveruizok @SomeHats)
🚀 Enhancement
- Migrate snapshot #1843 (@steveruizok)
🐛 Bug Fix
Authors: 3
- alex (@SomeHats)
- David Sheldrick (@ds300)
- Steve Ruiz (@steveruizok)
v2.0.0-alpha.14 (Tue Jul 04 2023)
Release Notes
[fix] mutating snapshot
in migrateStoreSnapshot
(#1663)
- [@tldraw/store] Fixed a bug that would cause
Store.migrateStoreSnapshot
to mutate itssnapshot
argument.
🐛 Bug Fix
- [fix] mutating
snapshot
inmigrateStoreSnapshot
#1663 (@steveruizok)
Authors: 1
- Steve Ruiz (@steveruizok)
v2.0.0-alpha.13 (Wed Jun 28 2023)
Release Notes
[improvement] store snapshot types (#1657)
- [dev] Rename
StoreSnapshot
toSerializedStore
- [dev] Create new
StoreSnapshot
as type related togetSnapshot
/loadSnapshot
tlschema cleanup (#1509)
- [editor] Remove
app.createShapeId
- [tlschema] Cleans up exports
Rename tlstore to store (#1507)
- Replace @tldraw/tlstore with @tldraw/store
💥 Breaking Change
- [tweak] migrate store snapshot arguments #1659 (@steveruizok)
- [improvement] store snapshot types #1657 (@steveruizok)
- Independent instance state persistence #1493 (@ds300)
- tlschema cleanup #1509 (@steveruizok)
- Rename tlstore to store #1507 (@steveruizok)
⚠️ Pushed to main
- update lazyrepo (@ds300)
🔩 Dependency Updates
- Incorporate signia as @tldraw/state #1620 (@steveruizok @ds300)
Authors: 2
- David Sheldrick (@ds300)
- Steve Ruiz (@steveruizok)
v2.0.0-alpha.12 (Mon Apr 03 2023)
🐛 Bug Fix
- Make sure all types and build stuff get run in CI #1548 (@SomeHats)
- add pre-commit api report generation #1517 (@SomeHats)
- [chore] restore api extractor #1500 (@steveruizok)
- Asset loading overhaul #1457 (@SomeHats)
- David/publish good #1488 (@ds300)
- [chore] alpha 10 #1486 (@ds300)
- [chore] package build improvements #1484 (@ds300)
- [chore] bump for alpha 8 #1485 (@steveruizok)
- [fix] page point offset #1483 (@steveruizok)
- stop using broken-af turbo for publishing #1476 (@ds300)
- [chore] add canary release script #1423 (@ds300 @steveruizok)
- [chore] upgrade yarn #1430 (@ds300)
- flush store on attach #1449 (@ds300)
- [fix] dev version number for tldraw/tldraw #1434 (@steveruizok)
- repo cleanup #1426 (@steveruizok)
- [fix] use polyfill for
structuredClone
#1408 (@TodePond @steveruizok) - Run all the tests. Fix linting for tests. #1389 (@MitjaBezensek)
Authors: 5
- alex (@SomeHats)
- David Sheldrick (@ds300)
- Lu[ke] Wilson (@TodePond)
- Mitja Bezenšek (@MitjaBezensek)
- Steve Ruiz (@steveruizok)
@tldraw/tlstore
2.0.0-alpha.11
Patch Changes
- fix some package build scripting
- Updated dependencies
- @tldraw/utils@2.0.0-alpha.10
2.0.0-alpha.10
Patch Changes
- 4b4399b6e: redeploy with yarn to prevent package version issues
- Updated dependencies [4b4399b6e]
- @tldraw/utils@2.0.0-alpha.9
2.0.0-alpha.9
Patch Changes
- Release day!
- Updated dependencies
- @tldraw/utils@2.0.0-alpha.8
2.0.0-alpha.8
Patch Changes
- 23dd81cfe: Make signia a peer dependency
2.0.0-alpha.7
Patch Changes
- Bug fixes.
- Updated dependencies
- @tldraw/utils@2.0.0-alpha.7
2.0.0-alpha.6
Patch Changes
- Add licenses.
- Updated dependencies
- @tldraw/utils@2.0.0-alpha.6
2.0.0-alpha.5
Patch Changes
- Add CSS files to tldraw/tldraw.
- Updated dependencies
- @tldraw/utils@2.0.0-alpha.5
2.0.0-alpha.4
Patch Changes
- Add children to tldraw/tldraw
- Updated dependencies
- @tldraw/utils@2.0.0-alpha.4
2.0.0-alpha.3
Patch Changes
- Change permissions.
- Updated dependencies
- @tldraw/utils@2.0.0-alpha.3
2.0.0-alpha.2
Patch Changes
- Add tldraw, editor
- Updated dependencies
- @tldraw/utils@2.0.0-alpha.2
0.1.0-alpha.11
Patch Changes
- Fix stale reactors.
- Updated dependencies
- @tldraw/utils@0.1.0-alpha.11
0.1.0-alpha.10
Patch Changes
- Fix type export bug.
- Updated dependencies
- @tldraw/utils@0.1.0-alpha.10
0.1.0-alpha.9
Patch Changes
- Fix import bugs.
- Updated dependencies
- @tldraw/utils@0.1.0-alpha.9
0.1.0-alpha.8
Patch Changes
- Changes validation requirements, exports validation helpers.
- Updated dependencies
- @tldraw/utils@0.1.0-alpha.8
0.1.0-alpha.7
Patch Changes
-
- Pre-pre-release update
- Updated dependencies
- @tldraw/utils@0.1.0-alpha.7
0.0.2-alpha.1
Patch Changes
- Fix error with HMR
- Updated dependencies
- @tldraw/utils@0.0.2-alpha.1
0.0.2-alpha.0
Patch Changes
- Initial release
- Updated dependencies
- @tldraw/utils@0.0.2-alpha.0