Skip to main content

Function: assetSchema()

assetSchema<C, I>(__namedParameters): object

Defined in: src/lib/assets/schema.ts:181

The schema of an asset of one kind: its header (see Asset) and its content.

Type Parameters​

C​

C extends object

I​

I extends object

Parameters​

__namedParameters​

AssetSchemaOptions<C, I>

Returns​

object

@type​

readonly @type: string = type

$id​

readonly $id: string

$schema​

readonly $schema: "https://json-schema.org/draft/2020-12/schema" = SCHEMA_DIALECT

additionalProperties​

readonly additionalProperties: false = false

properties​

readonly properties: object

properties.@type​

readonly @type: object

properties.@type.const​

readonly const: string = type

properties.$schema​

readonly $schema: object = fileSchemaUrlSchema

properties.$schema.maxLength​

readonly maxLength: 2048 = MAX_URL_LENGTH

properties.$schema.minLength​

readonly minLength: 1 = 1

properties.$schema.type​

readonly type: "string" = "string"

properties.author​

readonly author: object = assetHeaderSchema.properties.author

properties.author.anyOf​

readonly anyOf: readonly [{ maxLength: 100; minLength: 1; type: "string"; }, { additionalProperties: false; properties: { did: { maxLength: 2048; pattern: "^did:[a-z]+:[a-zA-Z0-9._:%-]+$"; type: "string"; }; email: { maxLength: 254; type: "string"; }; handle: { maxLength: 100; minLength: 1; type: "string"; }; homepage: { maxLength: 2048; type: "string"; }; name: { maxLength: 100; minLength: 1; type: "string"; }; }; required: readonly ["name"]; type: "object"; }]

properties.content​

content: C

properties.group​

readonly group: object = assetHeaderSchema.properties.group

properties.group.maxLength​

readonly maxLength: 100 = MAX_ASSET_TEXT_LENGTH

properties.group.minLength​

readonly minLength: 1 = 1

properties.group.pattern​

readonly pattern: "\\S" = "\\S"

properties.group.type​

readonly type: "string" = "string"

properties.id​

id: I

properties.name​

readonly name: object = assetTextSchema

properties.name.maxLength​

readonly maxLength: 100 = MAX_ASSET_TEXT_LENGTH

properties.name.minLength​

readonly minLength: 1 = 1

properties.name.pattern​

readonly pattern: "\\S" = "\\S"

properties.name.type​

readonly type: "string" = "string"

properties.updatedAt​

readonly updatedAt: object = assetHeaderSchema.properties.updatedAt

properties.updatedAt.pattern​

readonly pattern: "^\\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​

readonly type: "string" = "string"

properties.version​

readonly version: object = assetHeaderSchema.properties.version

properties.version.maxLength​

readonly maxLength: 20 = MAX_ASSET_VERSION_LENGTH

properties.version.minLength​

readonly minLength: 1 = 1

properties.version.type​

readonly type: "string" = "string"

required​

readonly required: readonly ["@type", "id", "name", "author", "content"]

type​

readonly type: "object" = "object"

Example​

assetSchema({ name: "colour-palette", version: "2.0.0", type: "PaintCanvas/ColourPalette",
id: { type: "string", pattern: UUID_PATTERN }, content: paletteContentSchema });