2024-04-16 11:13:54 +00:00
|
|
|
import {
|
|
|
|
BaseRecord,
|
|
|
|
createMigrationIds,
|
|
|
|
createRecordMigrationSequence,
|
|
|
|
createRecordType,
|
|
|
|
RecordId,
|
|
|
|
} from '@tldraw/store'
|
2024-02-14 17:53:30 +00:00
|
|
|
import { IndexKey, JsonObject } from '@tldraw/utils'
|
2023-06-03 08:27:44 +00:00
|
|
|
import { T } from '@tldraw/validate'
|
2023-06-03 20:46:53 +00:00
|
|
|
import { idValidator } from '../misc/id-validator'
|
2023-04-25 11:01:25 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* TLPage
|
|
|
|
*
|
|
|
|
* @public
|
|
|
|
*/
|
2023-05-24 11:25:41 +00:00
|
|
|
export interface TLPage extends BaseRecord<'page', TLPageId> {
|
2023-04-25 11:01:25 +00:00
|
|
|
name: string
|
2024-02-14 17:53:30 +00:00
|
|
|
index: IndexKey
|
2023-06-28 14:24:05 +00:00
|
|
|
meta: JsonObject
|
2023-04-25 11:01:25 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/** @public */
|
2023-06-03 20:46:53 +00:00
|
|
|
export type TLPageId = RecordId<TLPage>
|
2023-04-25 11:01:25 +00:00
|
|
|
|
2023-06-03 20:46:53 +00:00
|
|
|
/** @internal */
|
|
|
|
export const pageIdValidator = idValidator<TLPageId>('page')
|
|
|
|
|
|
|
|
/** @internal */
|
|
|
|
export const pageValidator: T.Validator<TLPage> = T.model(
|
2023-04-25 11:01:25 +00:00
|
|
|
'page',
|
|
|
|
T.object({
|
|
|
|
typeName: T.literal('page'),
|
|
|
|
id: pageIdValidator,
|
|
|
|
name: T.string,
|
2024-02-14 17:53:30 +00:00
|
|
|
index: T.indexKey,
|
2023-06-28 14:24:05 +00:00
|
|
|
meta: T.jsonValue as T.ObjectValidator<JsonObject>,
|
2023-04-25 11:01:25 +00:00
|
|
|
})
|
|
|
|
)
|
2023-06-28 14:24:05 +00:00
|
|
|
|
|
|
|
/** @internal */
|
2024-04-16 11:13:54 +00:00
|
|
|
export const pageVersions = createMigrationIds('com.tldraw.page', {
|
2023-06-28 14:24:05 +00:00
|
|
|
AddMeta: 1,
|
2024-04-16 11:13:54 +00:00
|
|
|
})
|
2023-06-28 14:24:05 +00:00
|
|
|
|
2023-06-03 20:46:53 +00:00
|
|
|
/** @internal */
|
2024-04-16 11:13:54 +00:00
|
|
|
export const pageMigrations = createRecordMigrationSequence({
|
|
|
|
sequenceId: 'com.tldraw.page',
|
|
|
|
recordType: 'page',
|
|
|
|
sequence: [
|
|
|
|
{
|
|
|
|
id: pageVersions.AddMeta,
|
|
|
|
up: (record: any) => {
|
|
|
|
record.meta = {}
|
2023-06-28 14:24:05 +00:00
|
|
|
},
|
|
|
|
},
|
2024-04-16 11:13:54 +00:00
|
|
|
],
|
2023-06-28 14:24:05 +00:00
|
|
|
})
|
2023-04-25 11:01:25 +00:00
|
|
|
|
|
|
|
/** @public */
|
2023-05-26 13:37:59 +00:00
|
|
|
export const PageRecordType = createRecordType<TLPage>('page', {
|
2023-06-03 20:46:53 +00:00
|
|
|
validator: pageValidator,
|
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-06-28 14:24:05 +00:00
|
|
|
}).withDefaultProperties(() => ({
|
|
|
|
meta: {},
|
|
|
|
}))
|
2023-05-22 21:46:24 +00:00
|
|
|
|
2023-05-27 17:53:18 +00:00
|
|
|
/** @public */
|
|
|
|
export function isPageId(id: string): id is TLPageId {
|
|
|
|
return PageRecordType.isId(id)
|
|
|
|
}
|