Variable: documentSchema
constdocumentSchema:object
Defined in: src/lib/document/schema.ts:142
JSON schema for a document file
Type Declaration
@type
readonly@type:"PaintCanvas/Document"=DOCUMENT_TYPE
$id
readonly$id:string
$schema
readonly$schema:"https://json-schema.org/draft/2020-12/schema"=SCHEMA_DIALECT
additionalProperties
readonlyadditionalProperties:false=false
properties
readonlyproperties:object
properties.@type
readonly@type:object
properties.@type.const
readonlyconst:"PaintCanvas/Document"=DOCUMENT_TYPE
properties.$schema
readonly$schema:object=fileSchemaUrlSchema
properties.$schema.maxLength
readonlymaxLength:2048=MAX_URL_LENGTH
properties.$schema.minLength
readonlyminLength:1=1
properties.$schema.type
readonlytype:"string"="string"
properties.activeLayer
readonlyactiveLayer:object
properties.activeLayer.maxLength
readonlymaxLength:100=100
properties.activeLayer.minLength
readonlyminLength:1=1
properties.activeLayer.type
readonlytype:"string"="string"
properties.author
readonlyauthor:object
properties.author.items
readonlyitems:object=authorDetailsSchema
properties.author.items.additionalProperties
readonlyadditionalProperties:false=false
properties.author.items.properties
readonlyproperties:object
properties.author.items.properties.did
readonlydid:object
properties.author.items.properties.did.maxLength
readonlymaxLength:2048=MAX_URL_LENGTH
properties.author.items.properties.did.pattern
readonlypattern:"^did:[a-z]+:[a-zA-Z0-9._:%-]+$"=DID_PATTERN
properties.author.items.properties.did.type
readonlytype:"string"="string"
properties.author.items.properties.email
readonlyemail:object
properties.author.items.properties.email.maxLength
readonlymaxLength:254=254
properties.author.items.properties.email.type
readonlytype:"string"="string"
properties.author.items.properties.handle
readonlyhandle:object=authorText
properties.author.items.properties.handle.maxLength
readonlymaxLength:100=MAX_AUTHOR_TEXT_LENGTH
properties.author.items.properties.handle.minLength
readonlyminLength:1=1
properties.author.items.properties.handle.type
readonlytype:"string"="string"
properties.author.items.properties.homepage
readonlyhomepage:object
properties.author.items.properties.homepage.maxLength
readonlymaxLength:2048=MAX_URL_LENGTH
properties.author.items.properties.homepage.type
readonlytype:"string"="string"
properties.author.items.properties.name
readonlyname:object=authorText
properties.author.items.properties.name.maxLength
readonlymaxLength:100=MAX_AUTHOR_TEXT_LENGTH
properties.author.items.properties.name.minLength
readonlyminLength:1=1
properties.author.items.properties.name.type
readonlytype:"string"="string"
properties.author.items.required
readonlyrequired: readonly ["name"]
properties.author.items.type
readonlytype:"object"="object"
properties.author.maxItems
readonlymaxItems:100=MAX_DOCUMENT_AUTHORS
properties.author.type
readonlytype:"array"="array"
properties.dateCreated
readonlydateCreated:object=date
properties.dateCreated.pattern
readonlypattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$" =DATE_TIME_PATTERN
properties.dateCreated.type
readonlytype:"string"="string"
properties.dateOpened
readonlydateOpened:object=date
properties.dateOpened.pattern
readonlypattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$" =DATE_TIME_PATTERN
properties.dateOpened.type
readonlytype:"string"="string"
properties.external
readonlyexternal:object
properties.external.items
readonlyitems:object
properties.external.items.additionalProperties
readonlyadditionalProperties:false=false
properties.external.items.properties
readonlyproperties:object
properties.external.items.properties.content
readonlycontent:object=image
properties.external.items.properties.content.maxLength
readonlymaxLength:number=MAX_DOCUMENT_IMAGE_LENGTH
properties.external.items.properties.content.pattern
readonlypattern:"^data:image/png;base64,[A-Za-z0-9+/]*={0,2}$"="^data:image/png;base64,[A-Za-z0-9+/]*={0,2}$"
properties.external.items.properties.content.type
readonlytype:"string"="string"
properties.external.items.properties.source
readonlysource:object
properties.external.items.properties.source.maxLength
readonlymaxLength:2048=2048
properties.external.items.properties.source.minLength
readonlyminLength:1=1
properties.external.items.properties.source.type
readonlytype:"string"="string"
properties.external.items.required
readonlyrequired: readonly ["source","content"]
properties.external.items.type
readonlytype:"object"="object"
properties.external.maxItems
readonlymaxItems:100=MAX_DOCUMENT_SHEETS
properties.external.type
readonlytype:"array"="array"
properties.height
readonlyheight:object=size
properties.height.maximum
readonlymaximum:10000=MAX_DOCUMENT_SIZE
properties.height.minimum
readonlyminimum:1=1
properties.height.type
readonlytype:"integer"="integer"
properties.id
readonlyid:object
properties.id.pattern
readonlypattern:"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"=UUID_PATTERN
properties.id.type
readonlytype:"string"="string"
properties.layers
readonlylayers:object
properties.layers.items
readonlyitems:object
properties.layers.items.additionalProperties
readonlyadditionalProperties:false=false
properties.layers.items.properties
readonlyproperties:object
properties.layers.items.properties.alphaLock
readonlyalphaLock:object
properties.layers.items.properties.alphaLock.type
readonlytype:"boolean"="boolean"
properties.layers.items.properties.blendingMode
readonlyblendingMode:object
properties.layers.items.properties.blendingMode.enum
readonlyenum: readonly ["source-over","screen","lighten","multiply","darken","overlay"] =DOCUMENT_BLEND_MODES
properties.layers.items.properties.content
readonlycontent:object=image
properties.layers.items.properties.content.maxLength
readonlymaxLength:number=MAX_DOCUMENT_IMAGE_LENGTH
properties.layers.items.properties.content.pattern
readonlypattern:"^data:image/png;base64,[A-Za-z0-9+/]*={0,2}$"="^data:image/png;base64,[A-Za-z0-9+/]*={0,2}$"
properties.layers.items.properties.content.type
readonlytype:"string"="string"
properties.layers.items.properties.id
readonlyid:object
properties.layers.items.properties.id.maxLength
readonlymaxLength:100=100
properties.layers.items.properties.id.minLength
readonlyminLength:1=1
properties.layers.items.properties.id.type
readonlytype:"string"="string"
properties.layers.items.properties.name
readonlyname:object
properties.layers.items.properties.name.maxLength
readonlymaxLength:64=64
properties.layers.items.properties.name.minLength
readonlyminLength:1=1
properties.layers.items.properties.name.pattern
readonlypattern: "\\S" = "\\S"
properties.layers.items.properties.name.type
readonlytype:"string"="string"
properties.layers.items.properties.opacity
readonlyopacity:object
properties.layers.items.properties.opacity.maximum
readonlymaximum:1=1
properties.layers.items.properties.opacity.minimum
readonlyminimum:0=0
properties.layers.items.properties.opacity.type
readonlytype:"number"="number"
properties.layers.items.properties.visible
readonlyvisible:object
properties.layers.items.properties.visible.type
readonlytype:"boolean"="boolean"
properties.layers.items.required
readonlyrequired: readonly ["id","name","visible","opacity","blendingMode","alphaLock","content"]
properties.layers.items.type
readonlytype:"object"="object"
properties.layers.maxItems
readonlymaxItems:100=MAX_DOCUMENT_LAYERS
properties.layers.minItems
readonlyminItems:1=1
properties.layers.type
readonlytype:"array"="array"
properties.name
name:
object
properties.name.maxLength
readonlymaxLength:100=MAX_DOCUMENT_NAME_LENGTH
properties.name.minLength
readonlyminLength:1=1
properties.name.pattern
readonlypattern: "\\S" = "\\S"
properties.name.type
readonlytype:"string"="string"
properties.thumbnail
readonlythumbnail:object
properties.thumbnail.additionalProperties
readonlyadditionalProperties:false=false
properties.thumbnail.properties
readonlyproperties:object
properties.thumbnail.properties.content
readonlycontent:object=image
properties.thumbnail.properties.content.maxLength
readonlymaxLength:number=MAX_DOCUMENT_IMAGE_LENGTH
properties.thumbnail.properties.content.pattern
readonlypattern:"^data:image/png;base64,[A-Za-z0-9+/]*={0,2}$"="^data:image/png;base64,[A-Za-z0-9+/]*={0,2}$"
properties.thumbnail.properties.content.type
readonlytype:"string"="string"
properties.thumbnail.properties.height
readonlyheight:object
properties.thumbnail.properties.height.maximum
readonlymaximum:200=THUMBNAIL_SIZE
properties.thumbnail.properties.height.minimum
readonlyminimum:1=1
properties.thumbnail.properties.height.type
readonlytype:"integer"="integer"
properties.thumbnail.properties.width
readonlywidth:object
properties.thumbnail.properties.width.maximum
readonlymaximum:200=THUMBNAIL_SIZE
properties.thumbnail.properties.width.minimum
readonlyminimum:1=1
properties.thumbnail.properties.width.type
readonlytype:"integer"="integer"
properties.thumbnail.required
readonlyrequired: readonly ["width","height","content"]
properties.thumbnail.type
readonlytype:"object"="object"
properties.updatedAt
readonlyupdatedAt:object=date
properties.updatedAt.pattern
readonlypattern: "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$" =DATE_TIME_PATTERN
properties.updatedAt.type
readonlytype:"string"="string"
properties.width
readonlywidth:object=size
properties.width.maximum
readonlymaximum:10000=MAX_DOCUMENT_SIZE
properties.width.minimum
readonlyminimum:1=1
properties.width.type
readonlytype:"integer"="integer"
required
readonlyrequired: readonly ["$schema","@type","id","name","author","dateCreated","dateOpened","width","height","layers","activeLayer","external"]
type
readonlytype:"object"="object"