optolith-database-schema 0.0.1

package/lib/types/DerivedCharacteristic.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @main DerivedCharacteristic
+ */
+import { PublicationRefs } from "./source/_PublicationRef";
+import { GroupCollection } from "./_Prerequisite";
+/**
+ * @title Derived Characteristic
+ */
+export declare type DerivedCharacteristic = {
+    /**
+     * An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    prerequisites?: GroupCollection.DerivedCharacteristic;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: Translation;
+    };
+};
+declare type Translation = {
+    /**
+     * The characteristic's name.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The characteristic's abbreviation.
+     * @minLength 1
+     */
+    abbreviation: string;
+    /**
+     * Possible calculation strings for the final value.
+     */
+    calculation?: Calculation;
+};
+/**
+ * Possible calculation strings for the final value.
+ */
+declare type Calculation = {
+    /**
+     * The default calculation string.
+     * @minLength 1
+     */
+    default: string;
+    /**
+     * The calculation string if only half of the primary attribute is used.
+     * @minLength 1
+     */
+    half_primary?: string;
+    /**
+     * The calculation string if no primary attribute is used.
+     * @minLength 1
+     */
+    no_primary?: string;
+};
+export {};

package/lib/types/DerivedCharacteristic.js

@@ -0,0 +1,4 @@
+/**
+ * @main DerivedCharacteristic
+ */
+export {};

package/lib/types/Element.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main Element
+ */
+/**
+ * @title Element
+ */
+export declare type Element = {
+    /**
+     * The element's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The element's name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/Element.js

@@ -0,0 +1,4 @@
+/**
+ * @main Element
+ */
+export {};

package/lib/types/ExperienceLevel.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @main ExperienceLevel
+ */
+/**
+ * Adventure Points and maximum values at hero creation.
+ * @title Experience Level
+ */
+export declare type ExperienceLevel = {
+    /**
+     * An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The AP value you get.
+     * @integer
+     */
+    adventure_points: number;
+    /**
+     * The highest possible attribute value.
+     * @integer
+     */
+    max_attribute_value: number;
+    /**
+     * The highest possible skill rating.
+     * @integer
+     */
+    max_skill_rating: number;
+    /**
+     * The highest possible combat technique rating.
+     * @integer
+     */
+    max_combat_technique_rating: number;
+    /**
+     * The limit for the sum of all attribute values.
+     * @integer
+     */
+    max_attribute_total: number;
+    /**
+     * The maximum of spells/chants you can activate.
+     * @integer
+     */
+    max_number_of_spells_liturgical_chants: number;
+    /**
+     * The maximum of spells of an unfamiliar tradition you can activate.
+     * @integer
+     */
+    max_number_of_unfamiliar_spells: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: Translation;
+    };
+};
+declare type Translation = {
+    /**
+     * The name of the experience level.
+     * @minLength 1
+     */
+    name: string;
+};
+export {};

package/lib/types/ExperienceLevel.js

@@ -0,0 +1,4 @@
+/**
+ * @main ExperienceLevel
+ */
+export {};

package/lib/types/EyeColor.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main EyeColor
+ */
+/**
+ * @title Eye Color
+ */
+export declare type EyeColor = {
+    /**
+     * The eye color's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The eye color.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/EyeColor.js

@@ -0,0 +1,4 @@
+/**
+ * @main EyeColor
+ */
+export {};

package/lib/types/HairColor.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main HairColor
+ */
+/**
+ * @title Hair Color
+ */
+export declare type HairColor = {
+    /**
+     * The hair color's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The hair color.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/HairColor.js

@@ -0,0 +1,4 @@
+/**
+ * @main HairColor
+ */
+export {};

package/lib/types/Lessons_Curriculum.d.ts

@@ -0,0 +1,297 @@
+/**
+ * @main Curriculum
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+/**
+ * This is a curriculum of a specified academy, containing the guideline,
+ * elective and restricted spellworks as well as the lesson packages of that
+ * academy.
+ * @title Curriculum
+ */
+export declare type Curriculum = {
+    /**
+     * The curriculum's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The institution's guideline's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    guideline_id: number;
+    /**
+     * The academy's elective spellworks package.
+     */
+    elective_spellworks?: ElectiveSpellworks;
+    /**
+     * The academy's restricted spellworks package.
+     */
+    restricted_spellworks?: RestrictedSpellworks;
+    /**
+     * A list of available lesson packages.
+     */
+    lesson_packages: LessonPackages;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the academy.
+             * @minLength 1
+             */
+            name: string;
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * The academy's elective spellworks package.
+ */
+declare type ElectiveSpellworks = {
+    tag: "DefinedByGameMaster";
+} | {
+    tag: "Explicit";
+    /**
+     * @minItems 1
+     */
+    list: ElectiveSpellwork[];
+};
+declare type ElectiveSpellwork = {
+    id: SpellworkId;
+    /**
+     * The elective spellwork may only take effect if a certain condition is met.
+     * The condition may be related to professions or profession variants, but it
+     * is designed so that it can work without a specific profession, as multiple
+     * may belong to an institute, but with referencing other entities instead.
+     */
+    restriction?: ElectiveSpellworkRestriction;
+};
+/**
+ * The elective spellwork may only take effect if a certain condition is met.
+ * The condition may be related to professions or profession variants, but it is
+ * designed so that it can work without a specific profession, as multiple may
+ * belong to an institute, but with referencing other entities instead.
+ */
+declare type ElectiveSpellworkRestriction = {
+    tag: "Element";
+    /**
+     * The element's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    id: number;
+};
+/**
+ * The academy's restricted spellworks package.
+ * @minItems 1
+ */
+declare type RestrictedSpellworks = RestrictedSpellwork[];
+/**
+ * The academy's restricted spellworks package.
+ */
+declare type RestrictedSpellwork = {
+    tag: "Property";
+    /**
+     * The identifier of the property that spellworks are disallowed from.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Exclude specific spellworks from the restriction.
+     * @minItems 1
+     */
+    exclude?: SpellworkId[];
+    /**
+     * Spellworks from this property up to a certain number are allowed.
+     * Spellworks excluded from this restriction definition using `exclude` do
+     * not contribute to the maximum.
+     */
+    maximum?: number;
+} | SpellworkId | {
+    tag: "DemonSummoning";
+} | {
+    tag: "Borbaradian";
+} | {
+    tag: "DamageIntelligent";
+};
+/**
+ * A list of available lesson packages.
+ */
+declare type LessonPackages = [LessonPackage, LessonPackage];
+/**
+ * @title Lesson Package
+ * @minProperties 3
+ */
+declare type LessonPackage = {
+    /**
+     * The lesson package's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The spell values difference of the lesson package. This field reflects the
+     * changes (difference) to the field of the same name in the profession
+     * package. If a spell gets to SR 0 because of this, it will be removed
+     * completely.
+     * @minItems 1
+     */
+    spellwork_changes?: {
+        base: SpellworkAdjustment;
+        replacement: SpellworkAdjustment;
+    }[];
+    skills?: SkillAdjustment[];
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the lesson package.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The spell values difference of the lesson package. Use this field to
+             * specify a text that is displayed instead of the generated
+             * `spellwork_changes` list. The field is displayed even if no list is
+             * present.
+             * @minLength 1
+             */
+            spellwork_changes?: string;
+        };
+    };
+};
+declare type SkillAdjustment = {
+    tag: "MeleeCombatTechnique";
+    /**
+     * The melee combat technique's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The combat technique points that will be added to the current combat
+     * technique rating.
+     * @integer
+     * @minimum -6
+     * @maximum 6
+     */
+    points: number;
+} | {
+    tag: "RangedCombatTechnique";
+    /**
+     * The ranged combat technique's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The combat technique points that will be added to the current combat
+     * technique rating.
+     * @integer
+     * @minimum -6
+     * @maximum 6
+     */
+    points: number;
+} | {
+    tag: "Skill";
+    /**
+     * The skill's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The skill points that will be added to the current skill rating.
+     * @integer
+     * @minimum -8
+     * @maximum 8
+     */
+    points: number;
+} | SpellworkAdjustment;
+declare type SpellworkAdjustment = {
+    tag: "Spell";
+    /**
+     * The spell's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The skill points that will be added to the current skill rating. If a
+     * spell gets to a skill rating of 0 because of this, it will be removed
+     * completely.
+     * @integer
+     * @minimum -10
+     * @maximum 10
+     */
+    points: number;
+    /**
+     * The target tradition's identifier. If the target spell is not from the
+     * Guild Mage tradition, specify the tradition identifier here.
+     * @integer
+     * @minimum 2
+     * @default 1
+     */
+    tradition_id?: number;
+} | {
+    tag: "Ritual";
+    /**
+     * The ritual's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The skill points that will be added to the current skill rating. If a
+     * ritual gets to a skill rating of 0 because of this, it will be removed
+     * completely.
+     * @integer
+     * @minimum -10
+     * @maximum 10
+     */
+    points: number;
+    /**
+     * The target tradition's identifier. If the target ritual is not from the
+     * Guild Mage tradition, specify the tradition identifier here.
+     * @integer
+     * @minimum 2
+     * @default 1
+     */
+    tradition_id?: number;
+};
+declare type SpellworkId = {
+    tag: "Spell";
+    /**
+     * The spell's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+} | {
+    tag: "Ritual";
+    /**
+     * The ritual's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export {};

package/lib/types/Lessons_Curriculum.js

@@ -0,0 +1,4 @@
+/**
+ * @main Curriculum
+ */
+export {};

package/lib/types/Lessons_Guideline.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @main Guideline
+ */
+/**
+ * @title Guideline
+ */
+export declare type Guideline = {
+    /**
+     * The region's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Maximum number of spells that can be exchanged.
+     * @integer
+     * @minimum 0
+     */
+    spellwork_changes_allowed: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The guideline name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/Lessons_Guideline.js

@@ -0,0 +1,4 @@
+/**
+ * @main Guideline
+ */
+export {};

package/lib/types/Locale.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @main Locales
+ */
+/**
+ * @title Supported locales
+ */
+declare type Locales = Locale[];
+/**
+ * @title Supported locale
+ */
+declare type Locale = {
+    /**
+     * The locale's identifier. An IETF language tag (BCP47).
+     * @pattern ^[a-z]{2}-[A-Z]{2}$
+     */
+    id: string;
+    /**
+     * Name of the language in it's language.
+     * @minLength 1
+     * @example "Deutsch"
+     * @example "English"
+     * @example "Nederlands"
+     */
+    name: string;
+    /**
+     * Region in which the language is spoken in it's language.
+     * @minLength 1
+     * @example "Deutschland"
+     * @example "United States"
+     * @example "België"
+     */
+    region: string;
+    /**
+     * The language is not (fully) implemented and thus needs to be excluded from
+     * stable releases.
+     */
+    is_missing_implementation?: boolean;
+};

package/lib/types/Locale.js

@@ -0,0 +1,4 @@
+"use strict";
+/**
+ * @main Locales
+ */

package/lib/types/MetaCondition.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @main MetaCondition
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+/**
+ * Meta Conditions are rule elements that work like conditions in the sense that
+ * they have four levels with different effects, but which are not explicitly
+ * listed as conditions.
+ * @title Meta Condition
+ */
+export declare type MetaCondition = {
+    /**
+     * The meta condition's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The meta condition's name.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * Additional rules for the meta condition, if applicable.
+             * @markdown
+             * @minLength 1
+             */
+            rules?: string;
+            /**
+             * The effects for level 1 to 4.
+             */
+            effects: [Effect, Effect, Effect, Effect];
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * The effect on a level.
+ * @markdown
+ * @minLength 1
+ */
+declare type Effect = string;
+export {};

package/lib/types/MetaCondition.js

@@ -0,0 +1,4 @@
+/**
+ * @main MetaCondition
+ */
+export {};