fix: include generated files in repo and package

.gitignore

@@ -1,3 +1,2 @@
-gen
 node_modules
 lib

gen/types.d.ts

@@ -0,0 +1,851 @@
+// Generated by TSONDB -- do not edit manually.
+
+/**
+ * An exported character object from Optolith.
+ */
+export interface Character {
+  /**
+   * A valid semantic version (https://semver.org), representing the character schema version of this file.
+   */
+  version: string
+
+  /**
+   * The character’s name.
+   */
+  name: string
+
+  /**
+   * Date of character creation, in ISO8601 format.
+   */
+  dateCreated: Date
+
+  /**
+   * Date of character last modified, in ISO8601 format.
+   */
+  dateLastModified: Date
+
+  /**
+   * An object storing all kinds of basic and calculated adventure points.
+   */
+  adventurePoints: AdventurePoints
+
+  /**
+   * An object storing the identifiers of the experience level the character started at and the current experience level, derived from total adventure points.
+   */
+  experienceLevel: ExperienceLevel
+
+  /**
+   * Describes whether the character creation is finished.
+   */
+  isCharacterCreationFinished: boolean
+
+  /**
+   * An object storing the identifiers of the race and its optional race variant.
+   */
+  race: Race
+
+  /**
+   * An object storing the identifier of the culture and if the cultural package has been applied.
+   */
+  culture: Culture
+
+  /**
+   * An object storing the identifiers of the profession, its instance and its optional profession variant.
+   */
+  profession: Profession
+
+  /**
+   * An object storing the identifiers of the curriculum and it’s optional lesson package.
+   */
+  curriculum?: Curriculum
+
+  /**
+   * The rules settings for the character.
+   */
+  rules: Rules
+
+  /**
+   * Personal data such as hair color and place of birth.
+   */
+  personalData: PersonalData
+
+  /**
+   * A list of active advantages.
+   */
+  advantages: Activatable[]
+
+  /**
+   * A list of active disadvantages.
+   */
+  disadvantages: Activatable[]
+
+  /**
+   * Lists of active special abilities, by group.
+   * 
+   * This object may grow if new special ability groups are introduced, which is not considered a breaking change.
+   */
+  specialAbilities: {
+    advancedCombatSpecialAbilities?: Activatable[]
+    advancedKarmaSpecialAbilities?: Activatable[]
+    advancedMagicalSpecialAbilities?: Activatable[]
+    advancedSkillSpecialAbilities?: Activatable[]
+    ancestorGlyphs?: Activatable[]
+    arcaneOrbEnchantments?: Activatable[]
+    attireEnchantments?: Activatable[]
+    beutelzauber?: Activatable[]
+    blessedTraditions?: Activatable[]
+    bowlEnchantments?: Activatable[]
+    brawlingSpecialAbilities?: Activatable[]
+    cauldronEnchantments?: Activatable[]
+    ceremonialItemSpecialAbilities?: Activatable[]
+    chronicleEnchantments?: Activatable[]
+    combatSpecialAbilities?: Activatable[]
+    combatStyleSpecialAbilities?: Activatable[]
+    commandSpecialAbilities?: Activatable[]
+    daggerRituals?: Activatable[]
+    familiarSpecialAbilities?: Activatable[]
+    fatePointSexSpecialAbilities?: Activatable[]
+    fatePointSpecialAbilities?: Activatable[]
+    foolsHatEnchantments?: Activatable[]
+    generalSpecialAbilities?: Activatable[]
+    haubenzauber?: Activatable[]
+    instrumentEnchantments?: Activatable[]
+    karmaSpecialAbilities?: Activatable[]
+    krallenkettenzauber?: Activatable[]
+    kristallkugelzauber?: Activatable[]
+    liturgicalStyleSpecialAbilities?: Activatable[]
+    lycantropicGifts?: Activatable[]
+    magicalSigns?: Activatable[]
+    magicalSpecialAbilities?: Activatable[]
+    magicalTraditions?: Activatable[]
+    magicStyleSpecialAbilities?: Activatable[]
+    orbEnchantments?: Activatable[]
+    pactGifts?: Activatable[]
+    protectiveWardingCircleSpecialAbilities?: Activatable[]
+    ringEnchantments?: Activatable[]
+    sermons?: Activatable[]
+    sexSpecialAbilities?: Activatable[]
+    sickleRituals?: Activatable[]
+    sikaryanDrainSpecialAbilities?: Activatable[]
+    skillStyleSpecialAbilities?: Activatable[]
+    spellSwordEnchantments?: Activatable[]
+    staffEnchantments?: Activatable[]
+    toyEnchantments?: Activatable[]
+    trinkhornzauber?: Activatable[]
+    vampiricGifts?: Activatable[]
+    visions?: Activatable[]
+    wandEnchantments?: Activatable[]
+    weaponEnchantments?: Activatable[]
+  }
+
+  /**
+   * A list of attributes with values above 8. Attributes that are not listed here default to 8.
+   */
+  attributes: Attribute[]
+
+  /**
+   * Computed, set and bought values for/of derived characteristics.
+   */
+  derivedCharacteristics: {
+    lifePoints: Energy
+
+    /**
+     * This property does not exist if the character does not have the active advantage Spellcaster and an active magical tradition special ability.
+     */
+    arcaneEnergy?: EnergyWithBuyBack
+
+    /**
+     * This property does not exist if the character does not have the active advantage Blessed One and an active blessed tradition special ability.
+     */
+    karmaPoints?: EnergyWithBuyBack
+
+    spirit: DerivedCharacteristic
+
+    toughness: DerivedCharacteristic
+
+    dodge: DerivedCharacteristic
+
+    initiative: DerivedCharacteristic
+
+    movement: DerivedCharacteristic
+
+    /**
+     * This property is not present if the required focus rules are not activated.
+     */
+    woundThreshold?: DerivedCharacteristic
+  }
+
+  /**
+   * A list of skills with values above 0. Skills that are not listed here default to 0.
+   */
+  skills: Skill[]
+
+  /**
+   * Lists of combat techniques, by group.
+   */
+  combatTechniques: {
+    /**
+     * A list of melee combat techniques with values above 6. Combat techniques that are not listed here default to 6.
+     */
+    melee: CombatTechnique[]
+
+    /**
+     * A list of ranged combat techniques with values above 6. Combat techniques that are not listed here default to 6.
+     */
+    ranged: CombatTechnique[]
+  }
+
+  /**
+   * A list of purchased cantrips.
+   */
+  cantrips?: TinyActivatable[]
+
+  /**
+   * A list of active spells.
+   */
+  spells?: ActivatableRatedWithEnhancements[]
+
+  /**
+   * A list of active rituals.
+   */
+  rituals?: ActivatableRatedWithEnhancements[]
+
+  /**
+   * Lists of magical actions, by group.
+   * 
+   * This object may grow if new magical actions are introduced, which is not considered a breaking change.
+   */
+  magicalActions?: {
+    curses?: ActivatableRated[]
+    elvenMagicalSongs?: ActivatableRated[]
+    dominationRituals?: ActivatableRated[]
+    magicalMelodies?: ActivatableRated[]
+    magicalDances?: ActivatableRated[]
+    jesterTricks?: ActivatableRated[]
+    animistPowers?: ActivatableRated[]
+    geodeRituals?: ActivatableRated[]
+    zibiljaRituals?: ActivatableRated[]
+    magicalRunes?: ActivatableRated[]
+  }
+
+  /**
+   * A list of purchased blessings.
+   */
+  blessings?: TinyActivatable[]
+
+  /**
+   * A list of active liturgical chants.
+   */
+  liturgicalChants?: ActivatableRatedWithEnhancements[]
+
+  /**
+   * A list of active ceremonies.
+   */
+  ceremonies?: ActivatableRatedWithEnhancements[]
+
+  /**
+   * The money the character owns.
+   */
+  purse: Purse
+}
+
+/**
+ * The entity’s identifier. A UUID or a locale code if it is registered as the locale entity.
+ */
+export type Character_ID = string
+
+/**
+ * An object storing all kinds of basic and calculated adventure points.
+ */
+export interface AdventurePoints {
+  /**
+   * Total adventure points.
+   */
+  total: number
+
+  /**
+   * Adventure points available.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  available: number
+
+  /**
+   * Adventure points spent.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spent: number
+
+  /**
+   * Adventure points spent on advantages.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnAdvantages: number
+
+  /**
+   * Adventure points spent on magical advantages.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnMagicalAdvantages: number
+
+  /**
+   * Adventure points spent on blessed advantages.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnBlessedAdvantages: number
+
+  /**
+   * Adventure points spent on disadvantages.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnDisadvantages: number
+
+  /**
+   * Adventure points spent on magical disadvantages.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnMagicalAisadvantages: number
+
+  /**
+   * Adventure points spent on blessed disadvantages.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnBlessedDisadvantages: number
+
+  /**
+   * Adventure points spent on race.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnRace: number
+
+  /**
+   * Adventure points spent on attributes.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnAttributes: number
+
+  /**
+   * Adventure points spent on skills.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnSkills: number
+
+  /**
+   * Adventure points spent on combat techniques.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnCombatTechniques: number
+
+  /**
+   * Adventure points spent on spells, rituals and its enhancements.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnSpells: number
+
+  /**
+   * Adventure points spent on cantrips.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnCantrips: number
+
+  /**
+   * Adventure points spent on all kinds of magical actions.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnMagicalActions: number
+
+  /**
+   * Adventure points spent on liturgical chant, ceremonies and its enhancements.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnMiturgicalChants: number
+
+  /**
+   * Adventure points spent on blessings.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnBlessings: number
+
+  /**
+   * Adventure points spent on all kinds of special abilities.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnSpecialAbilities: number
+
+  /**
+   * Adventure points spent on adding and buying back energy points.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  spentOnEnergies: number
+}
+
+/**
+ * An object storing the identifiers of the experience level the character started at and the current experience level, derived from total adventure points.
+ */
+export interface ExperienceLevel {
+  /**
+   * The start experience level identifier.
+   */
+  start: UUIDv4
+
+  /**
+   * The current experience level identifier.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  current: UUIDv4
+}
+
+/**
+ * An UUIDv4 identifier of an entry in the Optolith database.
+ */
+export type UUIDv4 = string
+
+/**
+ * An object storing the identifiers of the race and its optional race variant.
+ */
+export interface Race {
+  /**
+   * The base race.
+   */
+  base: UUIDv4
+
+  /**
+   * The race variant.
+   */
+  variant?: UUIDv4
+
+  /**
+   * The identifier of the attribute adjustment that has been selected from the race.
+   */
+  selectedAttributeAdjustment: UUIDv4
+}
+
+/**
+ * An object storing the identifier of the culture and if the cultural package has been applied.
+ */
+export interface Culture {
+  /**
+   * The culture identifier.
+   */
+  base: UUIDv4
+
+  /**
+   * Describes whether the cultural package has been applied when creating the character.
+   */
+  isCulturalPackageApplied: boolean
+}
+
+/**
+ * An object storing the identifiers of the profession, its instance and its optional profession variant.
+ */
+export interface Profession {
+  /**
+   * The profession instance identifier. Profession instances are versions of the same profession but slightly different values, such as in extension rule books existing professions might get an additional style special ability.
+   */
+  package: UUIDv4
+
+  /**
+   * The profession variant identifier.
+   */
+  variant?: UUIDv4
+
+  /**
+   * A custom name for the profession, if provided.
+   */
+  customName?: string
+}
+
+/**
+ * An object storing the identifiers of the curriculum and it’s optional lesson package.
+ */
+export interface Curriculum {
+  /**
+   * The educational institution's curriculum identifier.
+   */
+  educationalInstitution: UUIDv4
+
+  /**
+   * The lesson package identifier.
+   */
+  lessonPackage?: UUIDv4
+}
+
+/**
+ * The rules settings for the character.
+ */
+export interface Rules {
+  /**
+   * Whether the character makes use of all publications except for publications with adult content and adventures, which have to be specified explicitly using `includePublications`.
+   */
+  includeAllPublications: boolean
+
+  /**
+   * Explicitly used publications. If `includeAllPublications` is set to `true`, only affects publications that are not covered by `includeAllPublications`.
+   */
+  includePublications: UUIDv4[]
+
+  /**
+   * Active focus rules.
+   */
+  focusRules: FocusRule[]
+
+  /**
+   * Active optional rules. Each optional rule may have one or more options selected.
+   */
+  optionalRules: OptionalRule[]
+}
+
+/**
+ * An active focus rule.
+ */
+export interface FocusRule {
+  /**
+   * The focus rule identifier.
+   */
+  id: UUIDv4
+}
+
+/**
+ * An active optional rule. An optional rule may have one or more options selected.
+ */
+export interface OptionalRule {
+  /**
+   * The optional rule identifier.
+   */
+  id: UUIDv4
+
+  /**
+   * An array of one or more options. The exact meaning of each option varies based on the optional rule.
+   */
+  options?: UUIDv4[]
+}
+
+/**
+ * Personal data such as hair color and place of birth.
+ */
+export interface PersonalData {
+  /**
+   * The character’s sex. It does not have to be binary, although it always must be specified how to handle it in the context of binary sex prerequisites. You can also provide a custom sex with a custom name.
+   */
+  sex: string
+
+  /**
+   * The family names and/or family members.
+   */
+  family?: string
+
+  /**
+   * The place where the character was born.
+   */
+  placeOfBirth?: string
+
+  /**
+   * The date when the character was born.
+   */
+  dateOfBirth?: string
+
+  /**
+   * The age of the character.
+   */
+  age?: string
+
+  /**
+   * The hair color of the character.
+   */
+  hairColor?: Color
+
+  /**
+   * The eye color of the character.
+   */
+  eyeColor?: Color
+
+  /**
+   * The size of the character.
+   */
+  size?: string
+
+  /**
+   * The weight of the character.
+   */
+  weight?: string
+
+  /**
+   * The character’s title(s).
+   */
+  title?: string
+
+  /**
+   * The social status.
+   */
+  socialStatus?: UUIDv4
+
+  /**
+   * The character’s characteristics.
+   */
+  characteristics?: string
+
+  /**
+   * Other information about the character.
+   */
+  otherInfo?: string
+}
+
+/**
+ * A color, either predefined or custom.
+ */
+export type Color =
+  | {
+    kind: "Predefined"
+    Predefined: UUIDv4
+  }
+  | {
+    kind: "Custom"
+    Custom: string
+  }
+
+/**
+ * An activatable item reference. Activatables are advantages, disadvantages and special abilities.
+ */
+export interface Activatable {
+  /**
+   * The identifier.
+   */
+  id: UUIDv4
+}
+
+/**
+ * An attribute with its value.
+ */
+export interface Attribute {
+  /**
+   * The attribute identifier.
+   */
+  id: UUIDv4
+
+  /**
+   * The attribute value.
+   */
+  value: number
+}
+
+/**
+ * A derived characteristic representing an energy where points can be purchased and permanently lost.
+ */
+export interface Energy {
+  /**
+   * The base value.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  base: number
+
+  /**
+   * The modifier depending on relevant advantages, disadvantages and special abilities.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  modifier: number
+
+  /**
+   * The number of points purchased.
+   */
+  purchased: number
+
+  /**
+   * The number of points permanently lost.
+   */
+  permanently_lost: number
+
+  /**
+   * The (final) maximum.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  maximum: number
+}
+
+/**
+ * A derived characteristic representing an energy where points can be purchased and permanently lost, with the option to buy back lost points.
+ */
+export interface EnergyWithBuyBack {
+  /**
+   * The base value.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  base: number
+
+  /**
+   * The modifier depending on relevant advantages, disadvantages and special abilities.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  modifier: number
+
+  /**
+   * The number of points purchased.
+   */
+  purchased: number
+
+  /**
+   * The number of points permanently lost.
+   */
+  permanently_lost: number
+
+  /**
+   * The number of permanently lost points that have been bought back.
+   */
+  permanently_lost_bought_back: number
+
+  /**
+   * The (final) maximum.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  maximum: number
+}
+
+/**
+ * A derived characteristic with its calculated parts.
+ */
+export interface DerivedCharacteristic {
+  /**
+   * The base value.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  base: number
+
+  /**
+   * The modifier depending on relevant advantages, disadvantages and special abilities.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  modifier: number
+
+  /**
+   * The (final) value.
+   * 
+   * *Note: This value is read-only and recalculated by Optolith. Setting it to a different value will not influence calculation in Optolith.*
+   */
+  value: number
+}
+
+/**
+ * A skill with its rating.
+ */
+export interface Skill {
+  /**
+   * The skill identifier.
+   */
+  id: UUIDv4
+
+  /**
+   * The skill rating.
+   */
+  value: number
+}
+
+/**
+ * A combat technique with its rating.
+ */
+export interface CombatTechnique {
+  /**
+   * The combat technique identifier.
+   */
+  id: UUIDv4
+
+  /**
+   * The combat technique rating.
+   */
+  value: number
+}
+
+/**
+ * A tiny activatable item reference.
+ */
+export interface TinyActivatable {
+  /**
+   * The identifier.
+   */
+  id: UUIDv4
+}
+
+/**
+ * An activatable item with its rating and purchased enhancements.
+ */
+export interface ActivatableRatedWithEnhancements {
+  /**
+   * The skill identifier.
+   */
+  id: UUIDv4
+
+  /**
+   * The skill rating.
+   */
+  value: number
+
+  /**
+   * Purchased enhancements.
+   */
+  enhancements: UUIDv4[]
+}
+
+/**
+ * An activatable item with its rating.
+ */
+export interface ActivatableRated {
+  /**
+   * The skill identifier.
+   */
+  id: UUIDv4
+
+  /**
+   * The skill rating.
+   */
+  value: number
+}
+
+/**
+ * The money the character owns.
+ */
+export interface Purse {
+  /**
+   * The number of kreutzers the character owns.
+   */
+  kreutzers: number
+
+  /**
+   * The number of halers the character owns.
+   */
+  halers: number
+
+  /**
+   * The number of silverthalers the character owns.
+   */
+  silverthalers: number
+
+  /**
+   * The number of ducats the character owns.
+   */
+  ducats: number
+}

package.json

@@ -3,6 +3,7 @@
   "version": "0.2.1",
   "description": "Definitions for the characters of Optolith, a character creation tool for the Pen and Paper RPG “The Dark Eye 5”.",
   "files": [
+    "gen",
     "lib",
     "schema",
     "AUTHORS",