Interface ProfileRaw

A raw profile of the application.

Remarks

This is the raw data of the profile that is used by the persistence layer.

NOTE: There should be no top-level properties in this interface.
All properties should be nested under their respective categories.

Since

0.4.0

interface ProfileRaw {
    $schema: string;
    lineups: Lineup[];
    metadata: ProfileMetadata;
    participants: {
        entities: EntityRaw[];
        groups: ParticipantGroup[];
        patterns: (Omit<DisplayNamePattern<LineupParticipantPersonPrimitive>, "sequence"> & {
            sequence: SequenceItemLiteral[] | SequenceItemProperty[];
        })[];
        registry: ParticipantPersonRaw[];
    };
    presets: PresetRaw[];
    settings: Settings;
}

Hierarchy (view full)

ProfileRaw
- Profile

Index

Properties

$schema lineups metadata participants presets settings

Properties

$schema

$schema: string

The schema of the profile.

Remarks

A placeholder for exporting profile schema.

lineups

lineups: Lineup[]

The collection of lineups

metadata

metadata: ProfileMetadata

Data related to the profile

Remarks

This includes version information and other metadata.

participants

participants: {
    entities: EntityRaw[];
    groups: ParticipantGroup[];
    patterns: (Omit<DisplayNamePattern<LineupParticipantPersonPrimitive>, "sequence"> & {
        sequence: SequenceItemLiteral[] | SequenceItemProperty[];
    })[];
    registry: ParticipantPersonRaw[];
}

Databases related to the profile participants

presets

presets: PresetRaw[]

The collection of presets

settings

settings: Settings

Application settings