optolith-database-schema 0.0.4 → 0.1.2

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

@@ -0,0 +1,170 @@
+/**
+ * @main BlessedTradition
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+import { Identifier } from "../_Identifier";
+/**
+ * @title Blessed Tradition
+ */
+export declare type BlessedTradition = {
+    id: Activatable.Id;
+    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
+         * @maximum 8
+         */
+        id: number;
+    };
+    /**
+     * The tradition's aspects, if any
+     */
+    aspects?: [
+        {
+            /**
+             * The first aspect's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        },
+        {
+            /**
+             * The second aspect's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        }
+    ];
+    /**
+     * If a tradition restricts the possible blessings, the blessings that are not
+     * allowed.
+     * @minItems 3
+     * @maxItems 6
+     */
+    restricted_blessings?: {
+        /**
+         * The blessing's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    }[];
+    /**
+     * A list of favored combat techniques.
+     */
+    favored_combat_techniques?: {
+        tag: "All";
+    } | {
+        tag: "AllClose";
+    } | {
+        tag: "AllUsedInHunting";
+    } | {
+        tag: "Specific";
+        /**
+         * A list of specific favored combat techniques.
+         * @minItems 1
+         */
+        list: {
+            /**
+             * The combat technique's identifier.
+             */
+            id: Identifier.Group.CombatTechnique;
+        }[];
+    };
+    /**
+     * A list of favored skills.
+     * @minItems 1
+     */
+    favored_skills: {
+        /**
+         * The skill's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    }[];
+    /**
+     * On activation of the tradition, a specific number of skills from a list of
+     * skills must be selected as being favored.
+     * @minItems 1
+     */
+    favored_skills_selection?: {
+        /**
+         * The number of skills that can be selected.
+         * @integer
+         * @minimum 1
+         */
+        number: number;
+        /**
+         * The possible set of skills.
+         */
+        options: {
+            /**
+             * The skill's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        }[];
+    };
+    /**
+     * Is this a schamanistic tradition?
+     */
+    is_shamanistic: boolean;
+    /**
+     * The select option's identifier of the disadvantage *Principles* that
+     * represent this tradition's code, if any.
+     */
+    associated_principles_id?: number;
+    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;
+            /**
+             * A shorter name of the tradition's name, used in liturgical chant
+             * descriptions.
+             * @minLength 1
+             */
+            name_compressed: 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/BlessedTradition.js

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

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

@@ -0,0 +1,32 @@
+/**
+ * @main BrawlingSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Brawling Special Ability
+ */
+export declare type BrawlingSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    type: Activatable.CombatSpecialAbilityType;
+    combat_techniques: Activatable.ApplicableCombatTechniques;
+    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/BrawlingSpecialAbility.js

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

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

@@ -0,0 +1,33 @@
+/**
+ * @main CeremonialItemSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Ceremonial Item Special Ability
+ */
+export declare type CeremonialItemSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    aspect: Activatable.Aspect;
+    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/CeremonialItemSpecialAbility.js

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

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

@@ -0,0 +1,34 @@
+/**
+ * @main CombatSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Combat Special Ability
+ */
+export declare type CombatSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    usage_type: Activatable.CombatSpecialAbilityType;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    combat_techniques: Activatable.ApplicableCombatTechniques;
+    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/CombatSpecialAbility.js

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

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

@@ -0,0 +1,43 @@
+/**
+ * @main CombatStyleSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Combat Style Special Ability
+ */
+export declare type CombatStyleSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    usage_type: Activatable.CombatSpecialAbilityType;
+    /**
+     * Is this an armed or unarmed combat style?
+     */
+    type: {
+        tag: "Armed";
+    } | {
+        tag: "Unarmed";
+    };
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    advanced: Activatable.AdvancedSpecialAbilities;
+    combat_techniques: Activatable.ApplicableCombatTechniques;
+    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/CombatStyleSpecialAbility.js

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

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

@@ -0,0 +1,32 @@
+/**
+ * @main CombatSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Combat Special Ability
+ */
+export declare type CombatSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    usage_type: Activatable.CombatSpecialAbilityType;
+    combat_techniques: Activatable.ApplicableCombatTechniques;
+    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/CommandSpecialAbility.js

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

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

@@ -0,0 +1,30 @@
+/**
+ * @main FamiliarSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Familiar Special Ability
+ */
+export declare type FamiliarSpecialAbility = {
+    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;
+            effect: Activatable.Effect;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/FamiliarSpecialAbility.js

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

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

@@ -0,0 +1,30 @@
+/**
+ * @main FatePointSexSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Fate Point Sex Special Ability
+ */
+export declare type FatePointSexSpecialAbility = {
+    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/FatePointSexSpecialAbility.js

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

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

@@ -0,0 +1,32 @@
+/**
+ * @main FatePointSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Fate Point Special Ability
+ */
+export declare type FatePointSpecialAbility = {
+    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/FatePointSpecialAbility.js

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

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

@@ -0,0 +1,32 @@
+/**
+ * @main GeneralSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title General Special Ability
+ */
+export declare type GeneralSpecialAbility = {
+    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/GeneralSpecialAbility.js

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

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

@@ -0,0 +1,30 @@
+/**
+ * @main KarmaSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Karma Special Ability
+ */
+export declare type KarmaSpecialAbility = {
+    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/KarmaSpecialAbility.js

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

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

@@ -0,0 +1,33 @@
+/**
+ * @main KarmaSpecialAbility
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Karma Special Ability
+ */
+export declare type KarmaSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    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/LiturgicalStyleSpecialAbility.js

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

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

@@ -0,0 +1,30 @@
+/**
+ * @main LycantropicGift
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import * as Activatable from "../_Activatable";
+/**
+ * @title Lycantropic Gift
+ */
+export declare type LycantropicGift = {
+    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/LycantropicGift.js

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

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

@@ -0,0 +1,33 @@
+/**
+ * @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;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    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;
+        };
+    };
+};