2023-04-25 11:01:25 +00:00
|
|
|
import { BaseRecord, createRecordType, defineMigrations, ID } from '@tldraw/tlstore'
|
|
|
|
import { T } from '@tldraw/tlvalidate'
|
|
|
|
import { idValidator } from '../validation'
|
|
|
|
|
|
|
|
/**
|
|
|
|
* TLCamera
|
|
|
|
*
|
|
|
|
* @public
|
|
|
|
*/
|
2023-05-24 11:25:41 +00:00
|
|
|
export interface TLCamera extends BaseRecord<'camera', TLCameraId> {
|
2023-04-25 11:01:25 +00:00
|
|
|
x: number
|
|
|
|
y: number
|
|
|
|
z: number
|
|
|
|
}
|
|
|
|
|
|
|
|
/** @public */
|
|
|
|
export type TLCameraId = ID<TLCamera>
|
|
|
|
|
|
|
|
/** @public */
|
|
|
|
export const cameraTypeValidator: T.Validator<TLCamera> = T.model(
|
|
|
|
'camera',
|
|
|
|
T.object({
|
|
|
|
typeName: T.literal('camera'),
|
|
|
|
id: idValidator<TLCameraId>('camera'),
|
|
|
|
x: T.number,
|
|
|
|
y: T.number,
|
|
|
|
z: T.number,
|
|
|
|
})
|
|
|
|
)
|
|
|
|
|
|
|
|
/** @public */
|
2023-05-26 13:37:59 +00:00
|
|
|
export const CameraRecordType = createRecordType<TLCamera>('camera', {
|
2023-04-25 11:01:25 +00:00
|
|
|
validator: cameraTypeValidator,
|
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: 'instance',
|
2023-04-25 11:01:25 +00:00
|
|
|
}).withDefaultProperties(
|
|
|
|
(): Omit<TLCamera, 'id' | 'typeName'> => ({
|
|
|
|
x: 0,
|
|
|
|
y: 0,
|
|
|
|
z: 1,
|
|
|
|
})
|
|
|
|
)
|
2023-05-22 21:46:24 +00:00
|
|
|
|
|
|
|
/** @public */
|
|
|
|
export const cameraTypeMigrations = defineMigrations({})
|