2023-04-25 11:01:25 +00:00
|
|
|
import { BaseRecord, createRecordType, defineMigrations, ID } from '@tldraw/tlstore'
|
|
|
|
import { T } from '@tldraw/tlvalidate'
|
|
|
|
|
|
|
|
/**
|
|
|
|
* TLDocument
|
|
|
|
*
|
|
|
|
* @public
|
|
|
|
*/
|
|
|
|
export interface TLDocument extends BaseRecord<'document'> {
|
|
|
|
gridSize: number
|
|
|
|
}
|
|
|
|
|
|
|
|
// --- VALIDATION ---
|
|
|
|
/** @public */
|
|
|
|
export const documentTypeValidator: T.Validator<TLDocument> = T.model(
|
|
|
|
'document',
|
|
|
|
T.object({
|
|
|
|
typeName: T.literal('document'),
|
|
|
|
id: T.literal('document:document' as ID<TLDocument>),
|
|
|
|
gridSize: T.number,
|
|
|
|
})
|
|
|
|
)
|
|
|
|
|
|
|
|
// --- MIGRATIONS ---
|
|
|
|
// STEP 1: Add a new version number here, give it a meaningful name.
|
|
|
|
// It should be 1 higher than the current version
|
|
|
|
const Versions = {
|
|
|
|
Initial: 0,
|
|
|
|
} as const
|
|
|
|
|
|
|
|
/** @public */
|
|
|
|
export const documentTypeMigrations = defineMigrations({
|
|
|
|
firstVersion: Versions.Initial,
|
|
|
|
// STEP 2: Update the current version to point to your latest version
|
|
|
|
currentVersion: Versions.Initial,
|
|
|
|
// STEP 3: Add an up+down migration for the new version here
|
|
|
|
migrators: {},
|
|
|
|
})
|
|
|
|
|
|
|
|
/** @public */
|
|
|
|
export const TLDocument = createRecordType<TLDocument>('document', {
|
|
|
|
migrations: documentTypeMigrations,
|
|
|
|
validator: documentTypeValidator,
|
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
|
|
|
scope: 'document',
|
2023-04-25 11:01:25 +00:00
|
|
|
}).withDefaultProperties(
|
|
|
|
(): Omit<TLDocument, 'id' | 'typeName'> => ({
|
|
|
|
gridSize: 10,
|
|
|
|
})
|
|
|
|
)
|
|
|
|
|
|
|
|
// all document records have the same ID: 'document:document'
|
|
|
|
/** @public */
|
|
|
|
export const TLDOCUMENT_ID: ID<TLDocument> = TLDocument.createCustomId('document')
|