Tldraw/packages/tlschema/src/records/TLPage.ts

72 wiersze
1.4 KiB
TypeScript

import {
BaseRecord,
createMigrationIds,
createRecordMigrationSequence,
createRecordType,
RecordId,
} from '@tldraw/store'
import { IndexKey, JsonObject } from '@tldraw/utils'
import { T } from '@tldraw/validate'
import { idValidator } from '../misc/id-validator'
/**
* TLPage
*
* @public
*/
export interface TLPage extends BaseRecord<'page', TLPageId> {
name: string
index: IndexKey
meta: JsonObject
}
/** @public */
export type TLPageId = RecordId<TLPage>
/** @internal */
export const pageIdValidator = idValidator<TLPageId>('page')
/** @internal */
export const pageValidator: T.Validator<TLPage> = T.model(
'page',
T.object({
typeName: T.literal('page'),
id: pageIdValidator,
name: T.string,
index: T.indexKey,
meta: T.jsonValue as T.ObjectValidator<JsonObject>,
})
)
/** @internal */
export const pageVersions = createMigrationIds('com.tldraw.page', {
AddMeta: 1,
})
/** @internal */
export const pageMigrations = createRecordMigrationSequence({
sequenceId: 'com.tldraw.page',
recordType: 'page',
sequence: [
{
id: pageVersions.AddMeta,
up: (record: any) => {
record.meta = {}
},
},
],
})
/** @public */
export const PageRecordType = createRecordType<TLPage>('page', {
validator: pageValidator,
scope: 'document',
}).withDefaultProperties(() => ({
meta: {},
}))
/** @public */
export function isPageId(id: string): id is TLPageId {
return PageRecordType.isId(id)
}