optolith-database-schema 0.1.4 → 0.1.7

package/lib/types/prerequisites/single/PrimaryAttributePrerequisite.d.ts

@@ -0,0 +1,22 @@
+import { DisplayOption } from "../DisplayOption.js";
+/**
+ * @title Primary Attribute Prerequisite
+ */
+export declare type PrimaryAttributePrerequisite = {
+    tag: "PrimaryAttribute";
+    /**
+     * Is the required primary attribute for spellcasters or blessed ones?
+     */
+    category: {
+        tag: "Blessed";
+    } | {
+        tag: "Magical";
+    };
+    /**
+     * Required value of the attribute
+     * @integer
+     * @minimum 9
+     */
+    value: number;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/PrimaryAttributePrerequisite.js

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

package/lib/types/prerequisites/single/PublicationPrerequisite.d.ts

@@ -0,0 +1,13 @@
+import { DisplayOption } from "../DisplayOption.js";
+/**
+ * @title Publication Prerequisite
+ */
+export declare type PublicationPrerequisite = {
+    tag: "Publication";
+    /**
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/PublicationPrerequisite.js

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

package/lib/types/prerequisites/single/RacePrerequisite.d.ts

@@ -0,0 +1,14 @@
+import { OneOrManyNumericIdentifiers } from "../../_Identifier.js";
+import { DisplayOption } from "../DisplayOption.js";
+/**
+ * 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 Race Prerequisite
+ */
+export declare type RacePrerequisite = {
+    tag: "Culture";
+    id: OneOrManyNumericIdentifiers;
+    active: boolean;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/RacePrerequisite.js

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

package/lib/types/prerequisites/single/RatedPrerequisite.d.ts

@@ -0,0 +1,99 @@
+import { RatedIdentifier } from "../../_Identifier.js";
+import { DisplayOption } from "../DisplayOption.js";
+/**
+ * @title Rated Prerequisite
+ */
+export declare type RatedPrerequisite = {
+    tag: "Rated";
+    /**
+     * The rated entry's identifier.
+     */
+    id: RatedIdentifier;
+    /**
+     * The required minimum value.
+     * @integer
+     * @minimum 0
+     */
+    value: number;
+    display_option?: DisplayOption;
+};
+/**
+ * @title Rated Set Prerequisite
+ */
+export declare type RatedSetPrerequisite = {
+    tag: "RatedSet";
+    /**
+     * The possible rated entries' identifiers.
+     * @minItems 2
+     */
+    id: RatedIdentifier[];
+    /**
+     * The required minimum value.
+     * @integer
+     * @minimum 0
+     */
+    value: number;
+    display_option?: DisplayOption;
+};
+/**
+ * @title Rated Minimum Number Prerequisite
+ */
+export declare type RatedMinimumNumberPrerequisite = {
+    tag: "RatedMinimumNumber";
+    /**
+     * The minimum number of skills that need to be on the defined minimum skill
+     * rating.
+     * @integer
+     * @minimum 1
+     */
+    number: number;
+    /**
+     * The minimum skill rating the defined minimum number of skills need to be
+     * on.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The targets that contribute to satisfying the prerequisite.
+     */
+    targets: {
+        tag: "Skills";
+        /**
+         * The skills that are taken into account for satisfying the prerequisite.
+         * @minItems 2
+         * @uniqueItems
+         */
+        skills: {
+            /**
+             * The skill's identifier.
+             */
+            id: number;
+        }[];
+    } | {
+        tag: "Spellworks";
+        /**
+         * Spellworks with the referenced property are taken into account for
+         * satisfying the prerequisite.
+         */
+        property: {
+            /**
+             * The property's identifier.
+             */
+            id: number;
+        };
+    } | {
+        tag: "Liturgies";
+        /**
+         * Liturgies with the referenced aspect are taken into account for
+         * satisfying the prerequisite.
+         */
+        aspect: {
+            /**
+             * The aspect's identifier.
+             */
+            id: number;
+        };
+    };
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/RatedPrerequisite.js

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

package/lib/types/prerequisites/single/RulePrerequisite.d.ts

@@ -0,0 +1,10 @@
+import { ExtensionRuleIdentifier } from "../../_Identifier.js";
+import { DisplayOption } from "../DisplayOption.js";
+/**
+ * @title Rule Prerequisite
+ */
+export declare type RulePrerequisite = {
+    tag: "Rule";
+    id: ExtensionRuleIdentifier;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/RulePrerequisite.js

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

package/lib/types/prerequisites/single/SexPrerequisite.d.ts

@@ -0,0 +1,11 @@
+import { BinarySex } from "../../_Sex.js";
+import { DisplayOption } from "../DisplayOption.js";
+/**
+ * Requires a specific sex.
+ * @title Sex Prerequisite
+ */
+export declare type SexPrerequisite = {
+    tag: "Sex";
+    id: BinarySex;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/SexPrerequisite.js

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

package/lib/types/prerequisites/single/SocialStatusPrerequisite.d.ts

@@ -0,0 +1,16 @@
+import { DisplayOption } from "../DisplayOption.js";
+/**
+ * Requires a minimum social status.
+ * @title Social Status Prerequisite
+ */
+export declare type SocialStatusPrerequisite = {
+    tag: "SocialStatus";
+    /**
+     * The minimum social status' identifier.
+     * @integer
+     * @minimum 2
+     * @maximum 5
+     */
+    id: number;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/SocialStatusPrerequisite.js

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

package/lib/types/prerequisites/single/StatePrerequisite.d.ts

@@ -0,0 +1,11 @@
+import { OneOrManyNumericIdentifiers } from "../../_Identifier.js";
+import { DisplayOption } from "../DisplayOption.js";
+/**
+ * Requires a specific state or one of a specific set of states.
+ * @title State Prerequisite
+ */
+export declare type StatePrerequisite = {
+    tag: "Culture";
+    id: OneOrManyNumericIdentifiers;
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/StatePrerequisite.js

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

package/lib/types/prerequisites/single/TextPrerequisite.d.ts

@@ -0,0 +1,31 @@
+/**
+ * A prerequisite that is either not verifyable in general – e.g. roleplay or
+ * background information – or the referenced entities were not made available
+ * for use yet – e.g. races –, but which should be displayed, because it is part
+ * of the prerequisite string from the sources.
+ * @title Impossible Prerequisite
+ */
+export declare type TextPrerequisite = {
+    tag: "Text";
+    /**
+     * The method how the prerequisite should be verified. Either is passes all
+     * verification text or it denies all verification tests. The latter results
+     * in the associated entry to never be available for purchase.
+     */
+    verification: {
+        tag: "Pass";
+    } | {
+        tag: "Deny";
+    };
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         * @minLength 1
+         */
+        [localeId: string]: string;
+    };
+};

package/lib/types/prerequisites/single/TextPrerequisite.js

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

package/lib/types/prerequisites/single/TraditionPrerequisite.d.ts

@@ -0,0 +1,33 @@
+import { DisplayOption } from "../DisplayOption.js";
+/**
+ * @title Blessed Tradition Prerequisite
+ */
+export declare type BlessedTraditionPrerequisite = {
+    tag: "BlessedTradition";
+    /**
+     * The blessed tradition prerequisite may only be satified if the blessed
+     * tradition is either church or shamanistic.
+     */
+    restriction?: {
+        tag: "Church";
+    } | {
+        tag: "Shamanistic";
+    };
+    display_option?: DisplayOption;
+};
+/**
+ * @title Magical Tradition Prerequisite
+ */
+export declare type MagicalTraditionPrerequisite = {
+    tag: "MagicalTradition";
+    /**
+     * The magical tradition prerequisite may only be satified if the magical
+     * tradition can learn rituals or can bind familiars.
+     */
+    restriction?: {
+        tag: "CanLearnRituals";
+    } | {
+        tag: "CanBindFamiliars";
+    };
+    display_option?: DisplayOption;
+};

package/lib/types/prerequisites/single/TraditionPrerequisite.js

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

package/lib/types/rule/FocusRule.d.ts

@@ -1,8 +1,8 @@
 /**
  * @main FocusRule
  */
-import { Errata } from "../source/_Erratum";
-import { PublicationRefs } from "../source/_PublicationRef";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Focus Rule
  */
@@ -51,3 +51,4 @@ export declare type FocusRule = {
         };
     };
 };
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<FocusRule>;

package/lib/types/rule/FocusRule.js

@@ -1,4 +1,5 @@
 /**
  * @main FocusRule
  */
-export {};
+import { validateSchemaCreator } from "../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/rule/FocusRule_Subject.d.ts

@@ -29,3 +29,4 @@ export declare type Subject = {
         };
     };
 };
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Subject>;

package/lib/types/rule/FocusRule_Subject.js

@@ -1,4 +1,5 @@
 /**
  * @main Subject
  */
-export {};
+import { validateSchemaCreator } from "../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/rule/OptionalRule.d.ts

@@ -1,8 +1,8 @@
 /**
  * @main OptionalRule
  */
-import { Errata } from "../source/_Erratum";
-import { PublicationRefs } from "../source/_PublicationRef";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
 /**
  * @title Optional Rule
  */
@@ -62,4 +62,5 @@ declare type Relevance = {
      */
     isMissingImplementation?: boolean;
 };
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<OptionalRule>;
 export {};

package/lib/types/rule/OptionalRule.js

@@ -1,4 +1,5 @@
 /**
  * @main OptionalRule
  */
-export {};
+import { validateSchemaCreator } from "../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/source/Publication.d.ts

@@ -1,4 +1,91 @@
 /**
  * @main Publication
  */
+import { PublicationPrerequisites } from "../_Prerequisite.js";
+/**
+ * @title Publication
+ */
+export declare type Publication = {
+    /**
+     * The publication's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The publication category.
+     */
+    category: Category;
+    /**
+     * The age the content is restricted to.
+     */
+    age_restriction: AgeRestriction;
+    /**
+     * The publication is not (fully) implemented and thus needs to be excluded
+     * from * stable releases.
+     */
+    is_missing_implementation?: boolean;
+    /**
+     * The specific other publications this publication depends on data from.
+     */
+    prerequisites?: PublicationPrerequisites;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The publisher's publication identifier.
+             * @minLength 1
+             * @example US25001
+             */
+            id?: string;
+            /**
+             * The publication's name.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The publication's abbreviation.
+             * @minLength 1
+             */
+            abbreviation: string;
+            /**
+             * The publication's release date.
+             * @format date
+             */
+            release_date?: string;
+            /**
+             * This publication translation is not (fully) implemented and thus needs to
+             * be excluded from stable releases.
+             */
+            is_missing_implementation?: boolean;
+        };
+    };
+};
+/**
+ * The publication category.
+ */
+declare type Category = {
+    tag: "CoreRules";
+} | {
+    tag: "ExpansionRules";
+} | {
+    tag: "Sourcebook";
+} | {
+    tag: "RegionalSourcebook";
+};
+/**
+ * The age the content is restricted to.
+ */
+declare type AgeRestriction = {
+    tag: "Adult";
+} | {
+    tag: "None";
+};
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Publication>;
 export {};

package/lib/types/source/Publication.js

@@ -1,4 +1,5 @@
 /**
  * @main Publication
  */
-export {};
+import { validateSchemaCreator } from "../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -1,9 +1,10 @@
 /**
  * @main AdvancedCombatSpecialAbility
  */
-import { Errata } from "../source/_Erratum";
-import { PublicationRefs } from "../source/_PublicationRef";
-import * as Activatable from "../_Activatable";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+import * as Activatable from "../_Activatable.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Advanced Combat Special Ability
  */
@@ -11,10 +12,12 @@ export declare type AdvancedCombatSpecialAbility = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
     usage_type: Activatable.CombatSpecialAbilityType;
+    select_options?: Activatable.SelectOptions;
     skill_applications?: Activatable.SkillApplications;
     skill_uses?: Activatable.SkillUses;
     maximum?: Activatable.Maximum;
     penalty?: Activatable.Penalty;
+    prerequisites?: GeneralPrerequisites;
     combat_techniques: Activatable.ApplicableCombatTechniques;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;
@@ -30,7 +33,12 @@ export declare type AdvancedCombatSpecialAbility = {
             name: Activatable.Name;
             name_in_library?: Activatable.NameInLibrary;
             rules: Activatable.Rules;
+            /**
+             * @deprecated
+             */
+            penalty?: string;
             errata?: Errata;
         };
     };
 };
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AdvancedCombatSpecialAbility>;

package/lib/types/specialAbility/AdvancedCombatSpecialAbility.js

@@ -1,4 +1,5 @@
 /**
  * @main AdvancedCombatSpecialAbility
  */
-export {};
+import { validateSchemaCreator } from "../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -1,18 +1,21 @@
 /**
  * @main AdvancedKarmaSpecialAbility
  */
-import { Errata } from "../source/_Erratum";
-import { PublicationRefs } from "../source/_PublicationRef";
-import * as Activatable from "../_Activatable";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+import * as Activatable from "../_Activatable.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
 * @title Advanced Karma Special Ability
 */
 export declare type AdvancedKarmaSpecialAbility = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
     skill_applications?: Activatable.SkillApplications;
     skill_uses?: Activatable.SkillUses;
     maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;
     /**
@@ -31,3 +34,4 @@ export declare type AdvancedKarmaSpecialAbility = {
         };
     };
 };
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AdvancedKarmaSpecialAbility>;

package/lib/types/specialAbility/AdvancedKarmaSpecialAbility.js

@@ -1,4 +1,5 @@
 /**
  * @main AdvancedKarmaSpecialAbility
  */
-export {};
+import { validateSchemaCreator } from "../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -1,18 +1,21 @@
 /**
  * @main AdvancedMagicalSpecialAbility
  */
-import { Errata } from "../source/_Erratum";
-import { PublicationRefs } from "../source/_PublicationRef";
-import * as Activatable from "../_Activatable";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+import * as Activatable from "../_Activatable.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Advanced Magical Special Ability
  */
 export declare type AdvancedMagicalSpecialAbility = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
     skill_applications?: Activatable.SkillApplications;
     skill_uses?: Activatable.SkillUses;
     maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;
     /**
@@ -31,3 +34,4 @@ export declare type AdvancedMagicalSpecialAbility = {
         };
     };
 };
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AdvancedMagicalSpecialAbility>;

package/lib/types/specialAbility/AdvancedMagicalSpecialAbility.js

@@ -1,4 +1,5 @@
 /**
  * @main AdvancedMagicalSpecialAbility
  */
-export {};
+import { validateSchemaCreator } from "../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -1,18 +1,21 @@
 /**
  * @main AdvancedSkillSpecialAbility
  */
-import { Errata } from "../source/_Erratum";
-import { PublicationRefs } from "../source/_PublicationRef";
-import * as Activatable from "../_Activatable";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+import * as Activatable from "../_Activatable.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Advanced Skill Special Ability
  */
 export declare type AdvancedSkillSpecialAbility = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
     skill_applications?: Activatable.SkillApplications;
     skill_uses?: Activatable.SkillUses;
     maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;
     /**
@@ -31,3 +34,4 @@ export declare type AdvancedSkillSpecialAbility = {
         };
     };
 };
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AdvancedSkillSpecialAbility>;

package/lib/types/specialAbility/AdvancedSkillSpecialAbility.js

@@ -1,4 +1,5 @@
 /**
  * @main AdvancedSkillSpecialAbility
  */
-export {};
+import { validateSchemaCreator } from "../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -1,16 +1,19 @@
 /**
  * @main AncestorGlyph
  */
-import { Errata } from "../source/_Erratum";
-import { PublicationRefs } from "../source/_PublicationRef";
-import * as Activatable from "../_Activatable";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+import * as Activatable from "../_Activatable.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Ancestor Glyph
  */
 export declare type AncestorGlyph = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
     maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;
     /**
@@ -29,3 +32,4 @@ export declare type AncestorGlyph = {
         };
     };
 };
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AncestorGlyph>;