optolith-database-schema 0.11.3 → 0.11.4

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

@@ -1,18 +0,0 @@
-import { RatedIdentifier } from "../../_IdentifierGroup.js";
-import { DisplayOption } from "../DisplayOption.js";
-/**
- * @title Rated Prerequisite
- */
-export type RatedPrerequisite = {
-    /**
-     * The rated entry's identifier.
-     */
-    id: RatedIdentifier;
-    /**
-     * The required minimum value.
-     * @integer
-     * @minimum 0
-     */
-    value: number;
-    display_option?: DisplayOption;
-};

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

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

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

@@ -1,19 +0,0 @@
-import { SkillIdentifier } from "../../_IdentifierGroup.js";
-import { DisplayOption } from "../DisplayOption.js";
-/**
- * @title Rated Sum Prerequisite
- */
-export type RatedSumPrerequisite = {
-    /**
-     * The minimum required sum of the targets’ ratings.
-     * @integer
-     * @minimum 1
-     */
-    sum: number;
-    /**
-     * The targets that are included in calculating the sum.
-     * @minItems 2
-     */
-    targets: SkillIdentifier[];
-    display_option?: DisplayOption;
-};

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

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

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

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

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

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

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

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

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

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

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

@@ -1,11 +0,0 @@
-/**
- * Requires a specific sexual characteristic.
- * @title Sexual Characteristic Prerequisite
- */
-export type SexualCharacteristicPrerequisite = {
-    id: SexualCharacteristic;
-};
-export declare enum SexualCharacteristic {
-    Penis = "Penis",
-    Vagina = "Vagina"
-}

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

@@ -1,5 +0,0 @@
-export var SexualCharacteristic;
-(function (SexualCharacteristic) {
-    SexualCharacteristic["Penis"] = "Penis";
-    SexualCharacteristic["Vagina"] = "Vagina";
-})(SexualCharacteristic = SexualCharacteristic || (SexualCharacteristic = {}));

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

@@ -1,13 +0,0 @@
-import { SocialStatusIdentifier } from "../../_Identifier.js";
-import { DisplayOption } from "../DisplayOption.js";
-/**
- * Requires a minimum social status.
- * @title Social Status Prerequisite
- */
-export type SocialStatusPrerequisite = {
-    /**
-     * The minimum social status' identifier.
-     */
-    id: SocialStatusIdentifier;
-    display_option?: DisplayOption;
-};

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

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

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

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

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

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

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

@@ -1,55 +0,0 @@
-import { LocaleMap } from "../../_LocaleMap.js";
-import { NonEmptyMarkdown } from "../../_NonEmptyString.js";
-/**
- * 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 Text Prerequisite
- */
-export type TextPrerequisite = {
-    /**
-     * 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: TextVerificationRule;
-    /**
-     * If the text is a sentence or sentence-like fragment, this property ensures
-     * it is integrated into the prerequisite string correctly.
-     *
-     * A standalone sentence is connected to the previous prerequisite string with
-     * a period and a period is also added at the end of the sentence
-     * automatically, if it is not present. A connected sentence is connected to
-     * the previous prerequisite string with a semicolon and a period is not added
-     * to the end of the sentence. In this case, if there are prerequisites after
-     * this one, they will be connected using a semicolon again, unless a
-     * different punctuation mark is present at the end of the given text.
-     */
-    sentence_type?: SentenceType;
-    /**
-     * If the text does not represent an actual prerequisite but a prerequisite
-     * for the use of certain aspects or the entry the prerequisite is associated
-     * with, or something like that, this property is set to `true`.
-     *
-     * If all prerequisites of an entry are marked as meta, the entry is
-     * considered to have no prerequisites and thus the string `none` must be
-     * rendered before the list of meta prerequisites.
-     *
-     * This is the only use case for this property.
-     */
-    is_meta?: true;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<TextPrerequisiteTranslation>;
-};
-export declare enum TextVerificationRule {
-    Pass = "Pass",
-    Deny = "Deny"
-}
-export declare enum SentenceType {
-    Standalone = "Standalone",
-    Connected = "Connected"
-}
-export type TextPrerequisiteTranslation = NonEmptyMarkdown;

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

@@ -1,10 +0,0 @@
-export var TextVerificationRule;
-(function (TextVerificationRule) {
-    TextVerificationRule["Pass"] = "Pass";
-    TextVerificationRule["Deny"] = "Deny";
-})(TextVerificationRule = TextVerificationRule || (TextVerificationRule = {}));
-export var SentenceType;
-(function (SentenceType) {
-    SentenceType["Standalone"] = "Standalone";
-    SentenceType["Connected"] = "Connected";
-})(SentenceType = SentenceType || (SentenceType = {}));

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

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

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

@@ -1,18 +0,0 @@
-/**
- * The blessed tradition prerequisite may only be satified if the blessed
- * tradition is either church or shamanistic.
- */
-export var BlessedTraditionPrerequisiteRestriction;
-(function (BlessedTraditionPrerequisiteRestriction) {
-    BlessedTraditionPrerequisiteRestriction["Church"] = "Church";
-    BlessedTraditionPrerequisiteRestriction["Shamanistic"] = "Shamanistic";
-})(BlessedTraditionPrerequisiteRestriction = BlessedTraditionPrerequisiteRestriction || (BlessedTraditionPrerequisiteRestriction = {}));
-/**
- * The magical tradition prerequisite may only be satified if the magical
- * tradition can learn rituals or can bind familiars.
- */
-export var MagicalTraditionPrerequisiteRestriction;
-(function (MagicalTraditionPrerequisiteRestriction) {
-    MagicalTraditionPrerequisiteRestriction["CanLearnRituals"] = "CanLearnRituals";
-    MagicalTraditionPrerequisiteRestriction["CanBindFamiliars"] = "CanBindFamiliars";
-})(MagicalTraditionPrerequisiteRestriction = MagicalTraditionPrerequisiteRestriction || (MagicalTraditionPrerequisiteRestriction = {}));

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

@@ -1,312 +0,0 @@
-/**
- * @main CoreRule
- */
-import { TypeConfig } from "../../typeConfig.js";
-import { CoreRuleIdentifier } from "../_Identifier.js";
-import { CoreRuleDerivableContentIdentifier } from "../_IdentifierGroup.js";
-import { LocaleMap } from "../_LocaleMap.js";
-import { NonEmptyMarkdown, NonEmptyString } from "../_NonEmptyString.js";
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
-/**
- * @title Core Rule
- */
-export type CoreRule = {
-    /**
-     * The core rule's identifier. An unique, increasing integer.
-     */
-    id: CoreRuleIdentifier;
-    /**
-     * @minItems 1
-     */
-    content: ContentNode[];
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<CoreRuleTranslation>;
-};
-export type CoreRuleTranslation = {
-    /**
-     * The name of the optional rule.
-     */
-    name: NonEmptyString;
-    errata?: Errata;
-};
-export type ContentNode = {
-    tag: "Child";
-    child: ChildNode;
-} | {
-    tag: "Text";
-    text: TextNode;
-} | {
-    tag: "Reference";
-    reference: ReferenceNode;
-} | {
-    tag: "ReferenceList";
-    reference_list: ReferenceListNode;
-};
-/**
- * A core rule nested inside this core rule. It may be displayed as a separate
- * page or its content may be included in this rule's text, which will
- * automatically generate a proper heading. No content node of a type other than
- * `Child` should follow a child node, since then it may look like the the text
- * may be part of the child node.
- */
-export type ChildNode = {
-    /**
-     * The nested core rule's identifier.
-     */
-    id: CoreRuleIdentifier;
-    /**
-     * If the nested core rule's content should be integrated into this core rule
-     * and a proper heading should be added. Otherwise create a link to a separate
-     * view of that core rule.
-     */
-    include: boolean;
-};
-/**
- * A simple text block, containing one or multiple paragraphs. Headings are not
- * allowed, they should be handled as nested core rules instead.
- */
-export type TextNode = {
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<TextNodeTranslation>;
-};
-export type TextNodeTranslation = {
-    /**
-     * Markdown-formatted text.
-     */
-    text: NonEmptyMarkdown;
-};
-/**
- * Generate a list or table from a specific entity type.
- */
-export type ReferenceListNode = {
-    source: ReferenceListNodeSource;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<ReferenceListNodeTranslation>;
-};
-export type ReferenceListNodeSource = {
-    tag: "Attributes";
-    attributes: {};
-} | {
-    tag: "QualityLevels";
-    quality_levels: {};
-} | {
-    tag: "Conditions";
-    conditions: {};
-} | {
-    tag: "States";
-    states: {};
-} | {
-    tag: "ExperienceLevels";
-    experience_levels: {};
-} | {
-    tag: "Races";
-    races: {};
-} | {
-    tag: "Cultures";
-    cultures: {};
-} | {
-    tag: "Professions";
-    professions: {};
-} | {
-    tag: "Advantages";
-    advantages: {};
-} | {
-    tag: "Disadvantages";
-    disadvantages: {};
-} | {
-    tag: "CombatTechniques";
-    combat_techniques: {};
-} | {
-    tag: "SpecialAbilities";
-    special_abilities: {};
-} | {
-    tag: "PrimaryAttributes";
-    primary_attributes: {};
-} | {
-    tag: "DerivedCharacteristics";
-    derived_characteristics: {};
-} | {
-    tag: "StartingAge";
-    starting_age: {};
-} | {
-    tag: "Archetypes";
-    archetypes: {};
-} | {
-    tag: "RequirementsForRoutineChecks";
-    requirements_for_routine_checks: {};
-} | {
-    tag: "GeneralSpecialAbilities";
-    general_special_abilities: {};
-} | {
-    tag: "FatePointSpecialAbilities";
-    fate_point_special_abilities: {};
-} | {
-    tag: "LanguagesAndScripts";
-    languages_and_scripts: {};
-} | {
-    tag: "CloseCombatBotch";
-    close_combat_botch: {};
-} | {
-    tag: "DefenseBotch";
-    defense_botch: {};
-} | {
-    tag: "MeleeCombatTechniques";
-    melee_combat_techniques: {};
-} | {
-    tag: "RangedCombatBotch";
-    ranged_combat_botch: {};
-} | {
-    tag: "RangedCombatDefenseBotch";
-    ranged_combat_defense_botch: {};
-} | {
-    tag: "RangedCombatTechniques";
-    ranged_combat_techniques: {};
-} | {
-    tag: "CombatSpecialAbilities";
-    combat_special_abilities: {};
-} | {
-    tag: "Properties";
-    properties: {};
-} | {
-    tag: "SpellBotch";
-    spell_botch: {};
-} | {
-    tag: "Services";
-    services: {};
-} | {
-    tag: "ProtectiveAndWardingCircles";
-    protective_and_warding_circles: {};
-} | {
-    tag: "Elixirs";
-    elixirs: {};
-} | {
-    tag: "StaffEnchantments";
-    staff_enchantments: {};
-} | {
-    tag: "FamiliarsTricks";
-    familiars_tricks: {};
-} | {
-    tag: "Curses";
-    curses: {};
-} | {
-    tag: "ElvenMagicalSongs";
-    elven_magical_songs: {};
-} | {
-    tag: "MagicalSpecialAbilities";
-    magical_special_abilities: {};
-} | {
-    tag: "Cantrips";
-    cantrips: {};
-} | {
-    tag: "Spells";
-    spells: {};
-} | {
-    tag: "Rituals";
-    rituals: {};
-} | {
-    tag: "Aspects";
-    aspects: {};
-} | {
-    tag: "LiturgyBotch";
-    liturgy_botch: {};
-} | {
-    tag: "KarmaSpecialAbilities";
-    karma_special_abilities: {};
-} | {
-    tag: "Blessings";
-    blessings: {};
-} | {
-    tag: "LiturgicalChants";
-    liturgical_chants: {};
-} | {
-    tag: "Ceremonies";
-    ceremonies: {};
-} | {
-    tag: "SocialStatuses";
-    social_statuses: {};
-} | {
-    tag: "Poisons";
-    poisons: {};
-} | {
-    tag: "Diseases";
-    diseases: {};
-} | {
-    tag: "HealingHerbs";
-    healing_herbs: {};
-} | {
-    tag: "VisibilityModifier";
-    visibility_modifier: {};
-} | {
-    tag: "Demons";
-    demons: {};
-} | {
-    tag: "Elementals";
-    elementals: {};
-} | {
-    tag: "Animals";
-    animals: {};
-} | {
-    tag: "Familiars";
-    familiars: {};
-} | {
-    tag: "AnimalSpecialAbilities";
-    animal_special_abilities: {};
-} | {
-    tag: "EquipmentPackages";
-    equipment_packages: {};
-} | {
-    tag: "Items";
-    items: {};
-} | {
-    tag: "OptionalRules";
-    optional_rules: {};
-} | {
-    tag: "ImprovementCost";
-    improvement_cost: ReferenceListNodeImprovementCostSource;
-};
-export type ReferenceListNodeImprovementCostSource = {
-    /**
-     * Define if the cost for attributes or skills should be defined. The
-     * cost for attributes start with value 9, while the cost for skills
-     * start with 1 in addition to possible activation cost.
-     */
-    target: ReferenceListNodeImprovementCostSourceTarget;
-    /**
-     * The highest value the improvement cost are displayed for.
-     *
-     * The minimum maximum value should depend on what is the upper bound of
-     * the range of adventure point cost that are equal across multiple
-     * values (value increases for attributes are always 15 up to (and
-     * including) value 14, while value increases for skills are always 1 to
-     * 4, depending on the improvement cost, up to (and including) value
-     * 12), since those ranges should be combined into a single table row.
-     * @integer
-     * @minimum 12
-     */
-    maximum_rating: number;
-};
-export declare enum ReferenceListNodeImprovementCostSourceTarget {
-    Attributes = "Attributes",
-    Skills = "Skills"
-}
-export type ReferenceListNodeTranslation = {
-    /**
-     * Markdown-formatted text.
-     */
-    text: NonEmptyMarkdown;
-};
-/**
- * Generate the full text for a single entry as part of this core rule's text.
- */
-export type ReferenceNode = {
-    id: CoreRuleDerivableContentIdentifier;
-};
-export declare const config: TypeConfig<CoreRule>;

package/lib/types/rule/CoreRule.js

@@ -1,17 +0,0 @@
-/**
- * @main CoreRule
- */
-import { todo } from "../../validation/builders/integrity.js";
-import { createSchemaValidator } from "../../validation/builders/schema.js";
-import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
-export var ReferenceListNodeImprovementCostSourceTarget;
-(function (ReferenceListNodeImprovementCostSourceTarget) {
-    ReferenceListNodeImprovementCostSourceTarget["Attributes"] = "Attributes";
-    ReferenceListNodeImprovementCostSourceTarget["Skills"] = "Skills";
-})(ReferenceListNodeImprovementCostSourceTarget = ReferenceListNodeImprovementCostSourceTarget || (ReferenceListNodeImprovementCostSourceTarget = {}));
-export const config = {
-    name: "CoreRule",
-    id: getFIlenamePrefixAsNumericId,
-    integrityValidator: todo("CoreRule"),
-    schemaValidator: createSchemaValidator(import.meta.url),
-};

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

@@ -1,53 +0,0 @@
-/**
- * @main FocusRule
- */
-import { TypeConfig } from "../../typeConfig.js";
-import { LocaleMap } from "../_LocaleMap.js";
-import { NonEmptyMarkdown, NonEmptyString } from "../_NonEmptyString.js";
-import { FocusRuleSubjectReference } from "../_SimpleReferences.js";
-import { Errata } from "../source/_Erratum.js";
-import { PublicationRefs } from "../source/_PublicationRef.js";
-/**
- * @title Focus Rule
- */
-export type FocusRule = {
-    /**
-     * The focus rule's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * The associated subject.
-     */
-    subject: FocusRuleSubjectReference;
-    /**
-     * The focus rule's level.
-     * @integer
-     * @minimum 1
-     * @maximum 4
-     */
-    level: number;
-    /**
-     * Has the focus rule not been implemented in Optolith yet? This is also true
-     * if the focus rule does not (currently) apply to any Optolith feature.
-     */
-    is_missing_implementation: boolean;
-    src: PublicationRefs;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<FocusRuleTranslation>;
-};
-export type FocusRuleTranslation = {
-    /**
-     * The name of the focus rule.
-     */
-    name: NonEmptyString;
-    /**
-     * The description of the focus rule.
-     */
-    description: NonEmptyMarkdown;
-    errata?: Errata;
-};
-export declare const config: TypeConfig<FocusRule>;

package/lib/types/rule/FocusRule.js

@@ -1,12 +0,0 @@
-/**
- * @main FocusRule
- */
-import { todo } from "../../validation/builders/integrity.js";
-import { createSchemaValidator } from "../../validation/builders/schema.js";
-import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
-export const config = {
-    name: "FocusRule",
-    id: getFIlenamePrefixAsNumericId,
-    integrityValidator: todo("FocusRule"),
-    schemaValidator: createSchemaValidator(import.meta.url),
-};

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

@@ -1,29 +0,0 @@
-/**
- * @main Subject
- */
-import { TypeConfig } from "../../typeConfig.js";
-import { LocaleMap } from "../_LocaleMap.js";
-import { NonEmptyString } from "../_NonEmptyString.js";
-/**
- * Subjects or Subject Areas are the categories of Focus Rules.
- * @title Subject
- */
-export type Subject = {
-    /**
-     * The subject's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<SubjectTranslation>;
-};
-export type SubjectTranslation = {
-    /**
-     * The subject.
-     */
-    name: NonEmptyString;
-};
-export declare const config: TypeConfig<Subject>;