2023-04-25 11:01:25 +00:00
|
|
|
import { SerializedSchema } from './StoreSchema'
|
|
|
|
|
|
|
|
/** @public */
|
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
|
|
|
export const compareSchemas = (a: SerializedSchema, b: SerializedSchema): 0 | 1 | -1 => {
|
2023-04-25 11:01:25 +00:00
|
|
|
if (a.schemaVersion > b.schemaVersion) {
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
if (a.schemaVersion < b.schemaVersion) {
|
|
|
|
return -1
|
|
|
|
}
|
|
|
|
if (a.storeVersion > b.storeVersion) {
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
if (a.storeVersion < b.storeVersion) {
|
|
|
|
return -1
|
|
|
|
}
|
|
|
|
for (const key of Object.keys(a.recordVersions)) {
|
|
|
|
const aRecordVersion = a.recordVersions[key]
|
|
|
|
const bRecordVersion = b.recordVersions[key]
|
|
|
|
if (aRecordVersion.version > bRecordVersion.version) {
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
if (aRecordVersion.version < bRecordVersion.version) {
|
|
|
|
return -1
|
|
|
|
}
|
|
|
|
if ('subTypeVersions' in aRecordVersion && !('subTypeVersions' in bRecordVersion)) {
|
|
|
|
// todo: this assumes that subtypes were added in an up migration rather than removed. We should probably
|
|
|
|
// make sure that in either case the parent version is bumped
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!('subTypeVersions' in aRecordVersion) && 'subTypeVersions' in bRecordVersion) {
|
|
|
|
// todo: this assumes that subtypes were added in an up migration rather than removed. We should probably
|
|
|
|
// make sure that in either case the parent version is bumped
|
|
|
|
return -1
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!('subTypeVersions' in aRecordVersion) || !('subTypeVersions' in bRecordVersion)) {
|
|
|
|
// this will never happen
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
|
|
|
for (const subType of Object.keys(aRecordVersion.subTypeVersions)) {
|
|
|
|
const aSubTypeVersion = aRecordVersion.subTypeVersions[subType]
|
|
|
|
const bSubTypeVersion = bRecordVersion.subTypeVersions[subType]
|
|
|
|
if (aSubTypeVersion > bSubTypeVersion) {
|
|
|
|
return 1
|
|
|
|
}
|
|
|
|
if (aSubTypeVersion < bSubTypeVersion) {
|
|
|
|
return -1
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return 0
|
|
|
|
}
|