kopia lustrzana https://github.com/Tldraw/Tldraw
125 wiersze
3.1 KiB
TypeScript
125 wiersze
3.1 KiB
TypeScript
import { defineMigrations, ID, UnknownRecord } from '@tldraw/tlstore'
|
|
import { nanoid } from 'nanoid'
|
|
import { TLBaseShape } from '../shapes/shape-validation'
|
|
import { TLArrowShape } from '../shapes/TLArrowShape'
|
|
import { TLBookmarkShape } from '../shapes/TLBookmarkShape'
|
|
import { TLDrawShape } from '../shapes/TLDrawShape'
|
|
import { TLEmbedShape } from '../shapes/TLEmbedShape'
|
|
import { TLFrameShape } from '../shapes/TLFrameShape'
|
|
import { TLGeoShape } from '../shapes/TLGeoShape'
|
|
import { TLGroupShape } from '../shapes/TLGroupShape'
|
|
import { TLHighlightShape } from '../shapes/TLHighlightShape'
|
|
import { TLIconShape } from '../shapes/TLIconShape'
|
|
import { TLImageShape } from '../shapes/TLImageShape'
|
|
import { TLLineShape } from '../shapes/TLLineShape'
|
|
import { TLNoteShape } from '../shapes/TLNoteShape'
|
|
import { TLTextShape } from '../shapes/TLTextShape'
|
|
import { TLVideoShape } from '../shapes/TLVideoShape'
|
|
import { SmooshedUnionObject } from '../util-types'
|
|
import { TLPageId } from './TLPage'
|
|
|
|
/**
|
|
* The default set of shapes that are available in the editor.
|
|
*
|
|
* @public */
|
|
export type TLDefaultShape =
|
|
| TLArrowShape
|
|
| TLBookmarkShape
|
|
| TLDrawShape
|
|
| TLEmbedShape
|
|
| TLFrameShape
|
|
| TLGeoShape
|
|
| TLGroupShape
|
|
| TLImageShape
|
|
| TLLineShape
|
|
| TLNoteShape
|
|
| TLTextShape
|
|
| TLVideoShape
|
|
| TLIconShape
|
|
| TLHighlightShape
|
|
|
|
/**
|
|
* A type for a shape that is available in the editor but whose type is
|
|
* unknown—either one of the editor's default shapes or else a custom shape.
|
|
*
|
|
* @public */
|
|
export type TLUnknownShape = TLBaseShape<string, object>
|
|
|
|
/**
|
|
* The set of all shapes that are available in the editor, including unknown shapes.
|
|
*
|
|
* @public
|
|
*/
|
|
export type TLShape = TLDefaultShape | TLUnknownShape
|
|
|
|
/** @public */
|
|
export type TLShapePartial<T extends TLShape = TLShape> = T extends T
|
|
? {
|
|
id: TLShapeId
|
|
type: T['type']
|
|
props?: Partial<T['props']>
|
|
} & Partial<Omit<T, 'type' | 'id' | 'props'>>
|
|
: never
|
|
|
|
/** @public */
|
|
export type TLShapeId = ID<TLUnknownShape>
|
|
|
|
/** @public */
|
|
export type TLShapeProps = SmooshedUnionObject<TLShape['props']>
|
|
|
|
/** @public */
|
|
export type TLShapeProp = keyof TLShapeProps
|
|
|
|
/** @public */
|
|
export type TLParentId = TLPageId | TLShapeId
|
|
|
|
/** @public */
|
|
export type TLNullableShapeProps = { [K in TLShapeProp]?: TLShapeProps[K] | null }
|
|
|
|
const Versions = {
|
|
AddIsLocked: 1,
|
|
} as const
|
|
|
|
/** @internal */
|
|
export const rootShapeTypeMigrations = defineMigrations({
|
|
currentVersion: Versions.AddIsLocked,
|
|
migrators: {
|
|
[Versions.AddIsLocked]: {
|
|
up: (record) => {
|
|
return {
|
|
...record,
|
|
isLocked: false,
|
|
}
|
|
},
|
|
down: (record) => {
|
|
const { isLocked: _, ...rest } = record
|
|
return {
|
|
...rest,
|
|
}
|
|
},
|
|
},
|
|
},
|
|
})
|
|
|
|
/** @public */
|
|
export function isShape(record?: UnknownRecord): record is TLShape {
|
|
if (!record) return false
|
|
return record.typeName === 'shape'
|
|
}
|
|
|
|
/** @public */
|
|
export function isShapeId(id?: string): id is TLShapeId {
|
|
if (!id) return false
|
|
return id.startsWith('shape:')
|
|
}
|
|
|
|
/** @public */
|
|
export function createShapeId(): TLShapeId {
|
|
return `shape:${nanoid()}` as TLShapeId
|
|
}
|
|
|
|
/** @public */
|
|
export function createCustomShapeId(id: string): TLShapeId {
|
|
return `shape:${id}` as TLShapeId
|
|
}
|