tldraw/scripts
David Sheldrick 731da1bc77
derived presence state (#1204)
This PR adds

- A new `TLInstancePresence` record type, to collect info about the
presence state in a particular instance of the editor. This will
eventually be used to sync presence data instead of sending
instance-only state across the wire.
- **Record Scopes**

`RecordType` now has a `scope` property which can be one of three
things:
- `document`: the record belongs to the document and should be synced
and persisted freely. Currently: `TLDocument`, `TLPage`, `TLShape`, and
`TLAsset`
- `instance`: the record belongs to a single instance of the store and
should not be synced at all. It should not be persisted directly in most
cases, but rather compiled into a kind of 'instance configuration' to
store alongside the local document data so that when reopening the
associated document it can remember some of the previous instance state.
Currently: `TLInstance`, `TLInstancePageState`, `TLCamera`, `TLUser`,
`TLUserDocument`, `TLUserPresence`
- `presence`: the record belongs to a single instance of the store and
should not be persisted, but may be synced using the special presence
sync protocol. Currently just `TLInstancePresence`

This sets us up for the following changes, which are gonna be pretty
high-impact in terms of integrating tldraw into existing systems:

- Removing `instanceId` as a config option. Each instance gets a
randomly generated ID.
- We'd replace it with an `instanceConfig` option that has stuff like
selectedIds, camera positions, and so on. Then it's up to library users
to get and reinstate the instance config at persistence boundaries.
- Removing `userId` as config option, and removing the `TLUser` type
altogether.
- We might need to revisit when doing auth-enabled features like locking
shapes, but I suspect that will be separate.
2023-04-27 18:03:19 +00:00
..
lib transfer-out: transfer out 2023-04-25 12:01:25 +01:00
api-check.ts derived presence state (#1204) 2023-04-27 18:03:19 +00:00
build-api.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
build-package.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
CHANGELOG.md transfer-out: transfer out 2023-04-25 12:01:25 +01:00
check-scripts.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
clean.sh transfer-out: transfer out 2023-04-25 12:01:25 +01:00
lint.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
package.json [lite] upgrade lazyrepo (#1198) 2023-04-25 14:32:17 +01:00
postpack.sh transfer-out: transfer out 2023-04-25 12:01:25 +01:00
prepack.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
publish-canary.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
publish-manual.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
publish-new.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
refresh-assets.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
tsconfig.json transfer-out: transfer out 2023-04-25 12:01:25 +01:00
typecheck.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00