kopia lustrzana https://github.com/Tldraw/Tldraw
110 wiersze
3.2 KiB
TypeScript
110 wiersze
3.2 KiB
TypeScript
import { BaseRecord, createRecordType, defineMigrations, ID } from '@tldraw/tlstore'
|
|
import { T } from '@tldraw/tlvalidate'
|
|
import { idValidator, instanceIdValidator, pageIdValidator, userIdValidator } from '../validation'
|
|
import { TLInstance } from './TLInstance'
|
|
import { TLPage } from './TLPage'
|
|
import { TLUserId } from './TLUser'
|
|
|
|
/**
|
|
* TLUserDocument
|
|
*
|
|
* Settings that apply to this document for only the specified user
|
|
*
|
|
* @public
|
|
*/
|
|
export interface TLUserDocument extends BaseRecord<'user_document'> {
|
|
userId: TLUserId
|
|
isPenMode: boolean
|
|
isGridMode: boolean
|
|
isDarkMode: boolean
|
|
isMobileMode: boolean
|
|
isSnapMode: boolean
|
|
lastUpdatedPageId: ID<TLPage> | null
|
|
lastUsedTabId: ID<TLInstance> | null
|
|
}
|
|
|
|
/** @public */
|
|
export type TLUserDocumentId = ID<TLUserDocument>
|
|
|
|
// --- VALIDATION ---
|
|
/** @public */
|
|
export const userDocumentTypeValidator: T.Validator<TLUserDocument> = T.model(
|
|
'user_document',
|
|
T.object({
|
|
typeName: T.literal('user_document'),
|
|
id: idValidator<TLUserDocumentId>('user_document'),
|
|
userId: userIdValidator,
|
|
isPenMode: T.boolean,
|
|
isGridMode: T.boolean,
|
|
isDarkMode: T.boolean,
|
|
isMobileMode: T.boolean,
|
|
isSnapMode: T.boolean,
|
|
lastUpdatedPageId: pageIdValidator.nullable(),
|
|
lastUsedTabId: instanceIdValidator.nullable(),
|
|
})
|
|
)
|
|
|
|
// --- MIGRATIONS ---
|
|
// STEP 1: Add a new version number here, give it a meaningful name.
|
|
// It should be 1 higher than the current version
|
|
export const userDocumentVersions = {
|
|
Initial: 0,
|
|
AddSnapMode: 1,
|
|
AddMissingIsMobileMode: 2,
|
|
RemoveIsReadOnly: 3,
|
|
} as const
|
|
|
|
/** @public */
|
|
export const userDocumentTypeMigrations = defineMigrations({
|
|
firstVersion: userDocumentVersions.Initial,
|
|
// STEP 2: Update the current version to point to your latest version
|
|
currentVersion: userDocumentVersions.RemoveIsReadOnly,
|
|
// STEP 3: Add an up+down migration for the new version here
|
|
migrators: {
|
|
[userDocumentVersions.AddSnapMode]: {
|
|
up: (userDocument: TLUserDocument) => {
|
|
return { ...userDocument, isSnapMode: false }
|
|
},
|
|
down: ({ isSnapMode: _, ...userDocument }: TLUserDocument) => {
|
|
return userDocument
|
|
},
|
|
},
|
|
[userDocumentVersions.AddMissingIsMobileMode]: {
|
|
up: (userDocument: TLUserDocument) => {
|
|
return { ...userDocument, isMobileMode: userDocument.isMobileMode ?? false }
|
|
},
|
|
down: ({ isMobileMode: _, ...userDocument }: TLUserDocument) => {
|
|
return userDocument
|
|
},
|
|
},
|
|
[userDocumentVersions.RemoveIsReadOnly]: {
|
|
up: ({ isReadOnly: _, ...userDocument }: TLUserDocument & { isReadOnly: boolean }) => {
|
|
return userDocument
|
|
},
|
|
down: (userDocument: TLUserDocument) => {
|
|
return { ...userDocument, isReadOnly: false }
|
|
},
|
|
},
|
|
},
|
|
})
|
|
/* STEP 4: Add your changes to the record type */
|
|
|
|
/* STEP 5: Add up + down migrations for your new version */
|
|
/** @public */
|
|
export const TLUserDocument = createRecordType<TLUserDocument>('user_document', {
|
|
migrations: userDocumentTypeMigrations,
|
|
validator: userDocumentTypeValidator,
|
|
scope: 'instance',
|
|
}).withDefaultProperties(
|
|
(): Omit<TLUserDocument, 'id' | 'typeName' | 'userId'> => ({
|
|
/* STEP 6: Add any new default values for properties here */
|
|
isPenMode: false,
|
|
isGridMode: false,
|
|
isDarkMode: false,
|
|
isMobileMode: false,
|
|
isSnapMode: false,
|
|
lastUpdatedPageId: null,
|
|
lastUsedTabId: null,
|
|
})
|
|
)
|