optolith-database-schema 0.0.1

package/lib/types/_ActivatableSkill.js

@@ -0,0 +1,38 @@
+/**
+ * @title Activatable Skill
+ */
+export var CastingTime;
+(function (CastingTime) {
+    let CastingTimeDuringLovemakingUnit;
+    (function (CastingTimeDuringLovemakingUnit) {
+        CastingTimeDuringLovemakingUnit["SeductionActions"] = "SeductionActions";
+        CastingTimeDuringLovemakingUnit["Rounds"] = "Rounds";
+    })(CastingTimeDuringLovemakingUnit = CastingTime.CastingTimeDuringLovemakingUnit || (CastingTime.CastingTimeDuringLovemakingUnit = {}));
+    let SlowSkillCastingTimeUnit;
+    (function (SlowSkillCastingTimeUnit) {
+        SlowSkillCastingTimeUnit["Minutes"] = "Minutes";
+        SlowSkillCastingTimeUnit["Hours"] = "Hours";
+    })(SlowSkillCastingTimeUnit = CastingTime.SlowSkillCastingTimeUnit || (CastingTime.SlowSkillCastingTimeUnit = {}));
+})(CastingTime || (CastingTime = {}));
+export var Range;
+(function (Range) {
+    let Unit;
+    (function (Unit) {
+        Unit["Steps"] = "Steps";
+        Unit["Miles"] = "Miles";
+    })(Unit = Range.Unit || (Range.Unit = {}));
+})(Range || (Range = {}));
+export var Duration;
+(function (Duration) {
+    let Unit;
+    (function (Unit) {
+        Unit["Seconds"] = "Seconds";
+        Unit["Minutes"] = "Minutes";
+        Unit["Hours"] = "Hours";
+        Unit["Days"] = "Days";
+        Unit["Weeks"] = "Weeks";
+        Unit["Months"] = "Months";
+        Unit["Years"] = "Years";
+        Unit["CombatRounds"] = "CombatRounds";
+    })(Unit = Duration.Unit || (Duration.Unit = {}));
+})(Duration || (Duration = {}));

package/lib/types/_CommonnessRatedAdvantageDisadvantage.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Reference to a commonness-rated advantage or disadvantage. Commonness-rating terms used in the source books are strongly recommended, common, uncommon, suggested and unsuitable.
+ * @title Commonness-rated Advantage/Disadvantage
+ */
+export declare type CommonnessRatedAdvantageDisadvantage = {
+    /**
+     * The advantage's or disadvantage's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};

package/lib/types/_CommonnessRatedAdvantageDisadvantage.js

@@ -0,0 +1 @@
+export {};

package/lib/types/_ImprovementCost.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @title Improvement Cost
+ */
+export declare enum ImprovementCost {
+    A = "A",
+    B = "B",
+    C = "C",
+    D = "D"
+}

package/lib/types/_ImprovementCost.js

@@ -0,0 +1,10 @@
+/**
+ * @title Improvement Cost
+ */
+export var ImprovementCost;
+(function (ImprovementCost) {
+    ImprovementCost["A"] = "A";
+    ImprovementCost["B"] = "B";
+    ImprovementCost["C"] = "C";
+    ImprovementCost["D"] = "D";
+})(ImprovementCost || (ImprovementCost = {}));

package/lib/types/_Prerequisite.d.ts

@@ -0,0 +1,274 @@
+/**
+ * @title Prerequisites
+ */
+import { BinarySex } from "./_Sex";
+/**
+ * @title Single Prerequisites
+ */
+export declare namespace Single {
+    namespace DisplayOption {
+        /**
+         * @title Display Option
+         */
+        type T = {
+            tag: "Hide";
+        } | {
+            tag: "ReplaceWith";
+            /**
+             * All translations for the entry, identified by IETF language tag (BCP47).
+             * @minProperties 1
+             */
+            value: {
+                /**
+                 * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+                 */
+                [localeId: string]: string;
+            };
+        };
+    }
+    namespace Sex {
+        /**
+         * Requires a specific sex.
+         * @title Sex Prerequisite
+         */
+        type T = {
+            tag: "Sex";
+            id: BinarySex;
+            display_option?: DisplayOption.T;
+        };
+    }
+    namespace Race {
+        /**
+         * Requires a specific culture or one of a specific set of cultures.
+         * @title Race Prerequisite
+         */
+        export type T = {
+            tag: "Culture";
+            id: Identifier;
+            active: boolean;
+            display_option?: DisplayOption.T;
+        };
+        type Identifier = SingleIdentifier | MultipleIdentifiers;
+        /**
+         * @minimum 1
+         */
+        type SingleIdentifier = number;
+        /**
+         * @minItems 2
+         */
+        type MultipleIdentifiers = SingleIdentifier[];
+        export {};
+    }
+    namespace Culture {
+        /**
+         * Requires a specific race or one of a specific set of races. You can also
+         * provide an object to say whether the hero must meet one of the races or
+         * if the entry does not allow one of the races.
+         * @title Culture Prerequisite
+         */
+        export type T = {
+            tag: "Culture";
+            id: Identifier;
+            display_option?: DisplayOption.T;
+        };
+        type Identifier = SingleIdentifier | MultipleIdentifiers;
+        /**
+         * @minimum 1
+         */
+        type SingleIdentifier = number;
+        /**
+         * @minItems 2
+         */
+        type MultipleIdentifiers = SingleIdentifier[];
+        export {};
+    }
+    namespace Rule {
+        /**
+         * @title Rule Prerequisite
+         */
+        export type T = {
+            tag: "Rule";
+            id: Identifier;
+            display_option?: DisplayOption.T;
+        };
+        type Identifier = {
+            tag: "FocusRule";
+            /**
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+        } | {
+            tag: "OptionalRule";
+            /**
+             * @integer
+             * @minimum 1
+             */
+            value: number;
+        };
+        export {};
+    }
+    namespace Publication {
+        /**
+         * @title Publication Prerequisite
+         */
+        type T = {
+            tag: "Publication";
+            /**
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+            display_option?: DisplayOption.T;
+        };
+    }
+    namespace PrimaryAttribute {
+        /**
+         * @title Primary Attribute Prerequisite
+         */
+        type T = {
+            tag: "PrimaryAttribute";
+            /**
+             * Is the required primary attribute for spellcasters or blessed ones?
+             */
+            category: Category;
+            /**
+             * Required value of the attribute
+             * @integer
+             * @minimum 9
+             */
+            value: number;
+            display_option?: DisplayOption.T;
+        };
+        type Category = {
+            tag: "Blessed";
+        } | {
+            tag: "Magical";
+        };
+    }
+    namespace Pact {
+        /**
+         * Requires a specific pact.
+         * @title Pact Prerequisite
+         */
+        type T = {
+            tag: "Pact";
+            /**
+             * The required pact category's identifier.
+             * @integer
+             * @minimum 1
+             */
+            category_id: number;
+            /**
+             * The required domains' identifiers.
+             */
+            domain_id?: DomainId[];
+            /**
+             * The required pact level.
+             * @integer
+             * @minimum 1
+             */
+            level?: number;
+            display_option?: DisplayOption.T;
+        };
+        /**
+         * A domain's identifier.
+         * @integer
+         * @minimum 1
+         */
+        type DomainId = number;
+    }
+    namespace SocialStatus {
+        /**
+         * Requires a minimum social status.
+         * @title Social Status Prerequisite
+         */
+        type T = {
+            tag: "SocialStatus";
+            /**
+             * The minimum social status' identifier.
+             * @integer
+             * @minimum 2
+             * @maximum 5
+             */
+            id: number;
+            display_option?: DisplayOption.T;
+        };
+    }
+    namespace Influence {
+        /**
+         * @title Influence Prerequisite
+         */
+        type T = {
+            tag: "Influence";
+            /**
+             * The influence' identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+            /**
+             * If the referenced influence must or must not be chosen.
+             */
+            active: boolean;
+            display_option?: DisplayOption.T;
+        };
+    }
+}
+/**
+ * @title Grouped Prerequisites
+ */
+declare namespace Group {
+    type DerivedCharacteristic = Single.Rule.T;
+    type Publication = Single.Publication.T;
+    type ArcaneTradition = Single.Sex.T | Single.Culture.T;
+    type GeodeRitual = Single.Influence.T;
+}
+/**
+ * @title Prerequisite Collection Types
+ */
+declare namespace Collection {
+    type Plain<T> = {
+        tag: "Plain";
+        /**
+         * @minItems 1
+         */
+        value: T[];
+    };
+    type ByLevel<T> = {
+        tag: "Plain";
+        /**
+         * @minItems 1
+         */
+        value: T[];
+    } | {
+        tag: "ByLevel";
+        /**
+         * @minItems 1
+         */
+        value: {
+            /**
+             * @integer
+             * @minimum 1
+             */
+            level: number;
+            prerequisites: T[];
+        }[];
+    };
+}
+/**
+ * @title Grouped Prerequisite Collections
+ */
+export declare namespace GroupCollection {
+    type DerivedCharacteristic = Collection.Plain<Group.DerivedCharacteristic>;
+    type Publication = Collection.Plain<Group.Publication>;
+    /**
+     * @title Arcane Tradition Prerequisites
+     */
+    type ArcaneTradition = Collection.Plain<Group.ArcaneTradition>;
+    /**
+     * @title Geode Ritual Prerequisites
+     */
+    type GeodeRitual = Collection.Plain<Group.GeodeRitual>;
+}
+export {};

package/lib/types/_Prerequisite.js

@@ -0,0 +1,4 @@
+/**
+ * @title Prerequisites
+ */
+export {};

package/lib/types/_Sex.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @main BinarySex
+ */
+/**
+ * @title Binary Sex
+ */
+export declare type BinarySex = {
+    tag: "Male";
+} | {
+    tag: "Female";
+};

package/lib/types/_Sex.js

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

package/lib/types/_SkillCheck.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The attributes' identifiers of the skill check.
+ * @title Skill Check
+ */
+export declare type SkillCheck = [Attribute, Attribute, Attribute];
+declare type Attribute = {
+    /**
+     * The attribute's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 8
+     */
+    id: number;
+};
+/**
+ * A specific value that represents a penalty for the associated skill check.
+ * @title Skill Check Penalty
+ */
+export declare type SkillCheckPenalty = {
+    tag: "SPI";
+} | {
+    tag: "SPI/2";
+} | {
+    tag: "TOU";
+} | {
+    tag: "SPI/TOU";
+};
+export {};

package/lib/types/_SkillCheck.js

@@ -0,0 +1 @@
+export {};

package/lib/types/magicalActions/AnimistPower.d.ts

@@ -0,0 +1,227 @@
+/**
+ * @main AnimistPower
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { Duration, Effect } from "../_ActivatableSkill";
+import { ImprovementCost } from "../_ImprovementCost";
+import { SkillCheck } from "../_SkillCheck";
+/**
+ * @title Animist Power
+ */
+export declare type AnimistPower = {
+    /**
+     * The animist power's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * Measurable parameters of a animist power.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    /**
+     * The tribe traditions the animist power is available to. It may be available
+     * to all or only specific tribes.
+     */
+    tribe_tradition: {
+        tag: "General";
+    } | {
+        tag: "Specific";
+        /**
+         * The specific tribe traditions this animist power is available to.
+         * @minItems 1
+         * @uniqueItems
+         */
+        list: {
+            /**
+             * The tribe's identifier.
+             * @integer
+             * @minimum 1
+             * @maximum 6
+             */
+            id: number;
+        }[];
+    };
+    /**
+     * States which column is used to improve the skill. It is a fixed value or
+     * depends on the primary patron.
+     */
+    improvement_cost: {
+        tag: "Flat";
+        value: ImprovementCost;
+    } | {
+        tag: "ByPrimaryPatron";
+    };
+    /**
+     * The animist power can have multiple levels. Each level is skilled
+     * separately. A previous level must be on at least 10 so that the next higher
+     * level can be activated and skilled. A higher level cannot be skilled higher
+     * than a lower level. Each level also adds an effect text to the text of the
+     * first level.
+     * @minItems 1
+     */
+    levels?: {
+        /**
+         * The level number.
+         * @integer
+         * @minimum 2
+         */
+        level: number;
+        /**
+         * The source references, if different than the references for level 1.
+         */
+        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]: {
+                /**
+                 * An additional effect description for this level.
+                 * @markdown
+                 * @minLength 1
+                 */
+                effect: string;
+            };
+        };
+    }[];
+    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 animist power.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The full name of the entry as stated in the sources. Only use when
+             * `name` needs to be different from full name for text generation
+             * purposes.
+             * @minLength 1
+             */
+            name_in_library?: string;
+            /**
+             * The effect description may be either a plain text or a text that is
+             * divided by a list of effects for each quality level. It may also be a
+             * list for each two quality levels.
+             */
+            effect: Effect.T;
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a animist power.
+ */
+declare type PerformanceParameters = {
+    tag: "OneTime";
+    /**
+     * The AE cost value, either a flat value or defined dynamically by the
+     * primary patron.
+     */
+    cost: {
+        tag: "Fixed";
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * If defined, half of the AE cost `value` has to be paid each
+         * interval.
+         */
+        interval?: Duration.UnitValue;
+    } | {
+        tag: "ByPrimaryPatron";
+        /**
+         * If defined, half of the AE cost `value` has to be paid each
+         * interval.
+         */
+        interval?: Duration.UnitValue;
+    };
+    /**
+     * The duration.
+     */
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * If the duration is the maximum duration, so it may end earlier.
+         */
+        is_maximum?: boolean;
+        /**
+         * The (unitless) duration.
+         * @integer
+         * @minimum 2
+         */
+        value: number;
+        /**
+         * The duration unit.
+         */
+        unit: Duration.Unit;
+    } | Duration.CheckResultBasedTaggedAnimistPower;
+} | {
+    tag: "Sustained";
+    /**
+     * The AE cost value, either a flat value or defined dynamically by the
+     * primary patron.
+     */
+    cost: {
+        tag: "Fixed";
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * Half of the AE cost `value` has to be paid each interval.
+         */
+        interval: Duration.UnitValue;
+    } | {
+        tag: "ByPrimaryPatron";
+        /**
+         * Half of the AE cost `value` has to be paid each interval.
+         */
+        interval: Duration.UnitValue;
+    };
+};
+export {};

package/lib/types/magicalActions/AnimistPower.js

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

package/lib/types/magicalActions/AnimistPower_Tribe.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main Tribe
+ */
+/**
+ * @title Tribe
+ */
+export declare type Tribe = {
+    /**
+     * The tribe'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 tribe name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/magicalActions/AnimistPower_Tribe.js

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