optolith-database-schema 0.0.4 → 0.1.0

package/lib/types/specialAbility/MagicStyleSpecialAbility.js

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

package/lib/types/specialAbility/MagicalSpecialAbility.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @main MagicalSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Magical Special Ability
+ */
+export declare type MagicalSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            name_in_library?: Activatable.NameInLibrary;
+            rules: Activatable.Rules;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/MagicalSpecialAbility.js

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

package/lib/types/specialAbility/MagicalTradition.d.ts

@@ -0,0 +1,130 @@
+/**
+ * @main MagicalTradition
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+import { Influence } from "../_Influence";
+/**
+ * @title Magical Tradition
+ */
+export declare type MagicalTradition = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    /**
+     * The tradition's primary attribute. Leave empty if the tradition does not
+     * have one.
+     */
+    primary?: {
+        /**
+         * The attribute's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+        /**
+         * Typically, the value of the primary attribute (if one exists) is added
+         * onto the base of 20 AE to get the actual AE. But sometimes, only half the
+         * value is added.
+         */
+        use_half_for_arcane_energy: boolean;
+    };
+    /**
+     * Can a member of the tradition learn cantrips?
+     */
+    can_learn_cantrips: boolean;
+    /**
+     * Can a member of the tradition learn spells?
+     */
+    can_learn_spells: boolean;
+    /**
+     * Can a member of the tradition learn rituals?
+     */
+    can_learn_rituals: boolean;
+    /**
+     * Can this magical tradition bind familiars?
+     */
+    can_bind_familiars: boolean;
+    /**
+     * Does the tradition allow learning more traditions or having learned a
+     * different tradition before learning this tradition?
+     */
+    allows_multiple_traditions: boolean;
+    /**
+     * Is the maximum AP you're able to spent on magical advantages and able to
+     * get by magical disadvantages different than the default of 50 AP?
+     * @integer
+     * @minimum 25
+     * @maximum 30
+     * @multipleOf 5
+     */
+    alternative_magical_adventure_points_maximum: number;
+    /**
+     * Are advantages/disadvantages required to not exclusively apply to arcane
+     * spellworks, but also to the tradition's magical actions or applications?
+     */
+    require_non_spellwork_exclusive_effects: boolean;
+    /**
+     * Is this a magical dilettante tradition?
+     */
+    is_magical_dilettante: boolean;
+    /**
+     * If arcane spellworks from a different tradition count as arcane spellworks
+     * of this tradition, this is the different tradition's reference.
+     */
+    use_arcane_spellworks_from_tradition: {
+        /**
+         * The magical tradition's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    };
+    /**
+     * The Influences for the traditions. Influences are enabled by Focus Rules.
+     * @minItems 2
+     */
+    influences?: Influence[];
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            /**
+             * The name used for the traditions list of arcane spellworks if it is
+             * different than the `name` of the special ability.
+             * @minLength 1
+             */
+            name_for_arcane_spellworks?: string;
+            name_in_library?: Activatable.NameInLibrary;
+            /**
+             * The special rules of the tradition. They should be sorted like they are
+             * in the book.
+             * @minItems 1
+             */
+            special_rules: {
+                /**
+                 * An optional label that is displayed and placed before the actual
+                 * text.
+                 * @minLength 1
+                 */
+                label?: string;
+                /**
+                 * The text of a special rule.
+                 * @minLength 1
+                 */
+                text: string;
+            }[];
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/MagicalTradition.js

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

package/lib/types/specialAbility/PactGift.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @main PactGift
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+import { Identifier } from "../_Identifier";
+/**
+ * @title Pact Gift
+ */
+export declare type PactGift = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    permanent_demonic_consumption?: {
+        tag: "Fixed";
+        /**
+         * The levels of *Demonic Consumption* the pact gift causes.
+         * @integer
+         * @minimum 1
+         * @maximum 4
+         */
+        levels: number;
+    } | {
+        tag: "PerLevel";
+        /**
+         * The levels of *Demonic Consumption* the pact gift causes per activated
+         * level of the pact gift.
+         * @integer
+         * @minimum 1
+         * @maximum 4
+         */
+        levels: number;
+    };
+    /**
+     * This pact gift has direct influence on the existence of other entries. It
+     * may add or remove entries.
+     * @minItems 1
+     */
+    automatic_entries?: {
+        /**
+         * What type of action is applied to the target entry?
+         */
+        action: {
+            tag: "Add";
+        } | {
+            tag: "Remove";
+        };
+        /**
+         * If an entry is added or removed, does is cost or grant adventure points
+         * or is it free of charge?
+         */
+        apply_ap_value: boolean;
+        /**
+         * The entry that is to be added or removed. It can be a fixed entry or a
+         * selection where the player must choose one entry.
+         */
+        target: {
+            tag: "Selection";
+            list: {
+                tag: "MagicalTraditions";
+            } | {
+                tag: "MagicalDilettanteTraditions";
+            };
+        } | {
+            tag: "Fixed";
+            id: Identifier.Group.Activatable;
+        };
+    }[];
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            name_in_library?: Activatable.NameInLibrary;
+            effect: Activatable.Effect;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/PactGift.js

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

package/lib/types/specialAbility/ProtectiveWardingCircleSpecialAbility.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @main ProtectiveWardingCircleSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Protective Warding Circle Special Ability
+ */
+export declare type ProtectiveWardingCircleSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            name_in_library?: Activatable.NameInLibrary;
+            /**
+             * The rules for the protective circle variant.
+             * @markdown
+             * @minLength 1
+             */
+            protective_circle: string;
+            /**
+             * The rules for the warding circle variant.
+             * @markdown
+             * @minLength 1
+             */
+            warding_circle: string;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/ProtectiveWardingCircleSpecialAbility.js

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

package/lib/types/specialAbility/Sermon.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main Sermon
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Sermon
+ */
+export declare type Sermon = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            name_in_library?: Activatable.NameInLibrary;
+            rules: Activatable.Rules;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/Sermon.js

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

package/lib/types/specialAbility/SexSpecialAbility.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @main SexSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Sex Special Ability
+ */
+export declare type SexSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            name_in_library?: Activatable.NameInLibrary;
+            rules: Activatable.Rules;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/SexSpecialAbility.js

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

package/lib/types/specialAbility/SikaryanDrainSpecialAbility.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main SikaryanDrainSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Sikaryan Drain Special Ability
+ */
+export declare type SikaryanDrainSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            name_in_library?: Activatable.NameInLibrary;
+            rules: Activatable.Rules;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/SikaryanDrainSpecialAbility.js

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

package/lib/types/specialAbility/SkillStyleSpecialAbility.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @main MagicStyleSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Magic Style Special Ability
+ */
+export declare type MagicStyleSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    advanced: Activatable.AdvancedSpecialAbilities;
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            name_in_library?: Activatable.NameInLibrary;
+            rules: Activatable.Rules;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/SkillStyleSpecialAbility.js

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

package/lib/types/specialAbility/VampiricGift.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main VampiricGift
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Vampiric Gift
+ */
+export declare type VampiricGift = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            name_in_library?: Activatable.NameInLibrary;
+            rules: Activatable.Rules;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/VampiricGift.js

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

package/lib/types/specialAbility/Vision.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main Vision
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Vision
+ */
+export declare type Vision = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    ap_value: Activatable.AdventurePointsValue;
+    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]: {
+            name: Activatable.Name;
+            name_in_library?: Activatable.NameInLibrary;
+            rules: Activatable.Rules;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/Vision.js

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

package/lib/types/specialAbility/sub/Language.d.ts

@@ -0,0 +1,141 @@
+/**
+ * @main Language
+ */
+import { Errata } from "../../source/_Erratum";
+import { PublicationRefs } from "../../source/_PublicationRef";
+import { Prerequisite } from "../../_Prerequisite";
+/**
+ * @title Language
+ */
+export declare type Language = {
+    /**
+     * The language's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The continents this language is present on.
+     * @minItems 1
+     */
+    continent: {
+        /**
+         * The continent's identifier.
+         * @integer
+         * @minimum 1
+         * @maximum 3
+         */
+        id: number;
+        /**
+         * Is the language considered virtually extinct in this continent?
+         */
+        is_extinct: boolean;
+    }[];
+    /**
+     * Language-specific specializations. Either a list of possible options or a
+     * indefinite description of what may be a specialization.
+     */
+    specializations: {
+        tag: "Specific";
+        /**
+         * A list of specific possible specializations.
+         */
+        list: {
+            /**
+             * The specialization'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 name of the specialization.
+                     * @minLength 1
+                     */
+                    name: string;
+                    /**
+                     * The specialization description. It will be appended to the name in
+                     * parenthesis.
+                     * @minLength 1
+                     */
+                    description?: string;
+                };
+            };
+        }[];
+    } | {
+        tag: "Indefinite";
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * The specializations description.
+                 * @minLength 1
+                 */
+                description: string;
+                /**
+                 * An input label or placeholder text for an UI element if it differs
+                 * from the `description`.
+                 * @minLength 1
+                 */
+                label?: string;
+            };
+        };
+    };
+    prerequisites?: Prerequisite.GroupCollection.Language;
+    /**
+     * The maximum possible level of the language. Only specified if lower than
+     * default of 3.
+     * @minimum 1
+     * @maximum 2
+     * @default 3
+     */
+    max_level?: 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 name of the language.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * A list of alternative names.
+             * @minLength 1
+             */
+            alternative_names?: {
+                /**
+                 * An alternative name of the language.
+                 * @minLength 1
+                 */
+                name: string;
+            }[];
+            /**
+             * The description of the language.
+             * @minLength 1
+             */
+            description?: string;
+            errata?: Errata;
+        };
+    };
+};