optolith-database-schema 0.2.2 → 0.3.0

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

@@ -4,6 +4,8 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import { CoreRuleDerivableContentIdentifier } from "../_Identifier.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../_NonEmptyString.js";
 /**
  * @title Core Rule
  */
@@ -17,25 +19,32 @@ export declare type CoreRule = {
     /**
      * @minItems 1
      */
-    content: (ChildNode | TextNode | ReferenceNode | ReferenceListNode)[];
+    content: ContentNode[];
     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 optional rule.
-             * @minLength 1
-             */
-            name: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<CoreRuleTranslation>;
+};
+export declare type CoreRuleTranslation = {
+    /**
+     * The name of the optional rule.
+     */
+    name: NonEmptyString;
+    errata?: Errata;
+};
+export declare 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
@@ -44,8 +53,7 @@ export declare type CoreRule = {
  * `Child` should follow a child node, since then it may look like the the text
  * may be part of the child node.
  */
-declare type ChildNode = {
-    tag: "Child";
+export declare type ChildNode = {
     /**
      * The nested core rule's identifier.
      * @integer
@@ -53,9 +61,9 @@ declare type ChildNode = {
      */
     id: number;
     /**
-     * If `true`, integrate the nested core rule's content into this core rule and
-     * add a proper heading. Otherwise create a link to a separate view of that
-     * core rule.
+     * 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;
 };
@@ -63,202 +71,186 @@ declare type ChildNode = {
  * A simple text block, containing one or multiple paragraphs. Headings are not
  * allowed, they should be handled as nested core rules instead.
  */
-declare type TextNode = {
-    tag: "Text";
+export declare type TextNode = {
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * Markdown-formatted text.
-             * @markdown
-             * @minLength 1
-             */
-            text: string;
-        };
-    };
+    translations: LocaleMap<TextNodeTranslation>;
+};
+export declare type TextNodeTranslation = {
+    /**
+     * Markdown-formatted text.
+     */
+    text: NonEmptyMarkdown;
 };
 /**
  * Generate a list or table from a specific entity type.
  */
-declare type ReferenceListNode = {
-    tag: "DeriveMany";
-    content: {
-        source: {
-            tag: "Attributes";
-        } | {
-            tag: "QualityLevels";
-        } | {
-            tag: "Conditions";
-        } | {
-            tag: "States";
-        } | {
-            tag: "ExperienceLevels";
-        } | {
-            tag: "Races";
-        } | {
-            tag: "Cultures";
-        } | {
-            tag: "Professions";
-        } | {
-            tag: "Advantages";
-        } | {
-            tag: "Disadvantages";
-        } | {
-            tag: "CombatTechniques";
-        } | {
-            tag: "SpecialAbilities";
-        } | {
-            tag: "PrimaryAttributes";
-        } | {
-            tag: "DerivedCharacteristics";
-        } | {
-            tag: "StartingAge";
-        } | {
-            tag: "Archetypes";
-        } | {
-            tag: "RequirementsForRoutineChecks";
-        } | {
-            tag: "GeneralSpecialAbilities";
-        } | {
-            tag: "FatePointSpecialAbilities";
-        } | {
-            tag: "LanguagesAndScripts";
-        } | {
-            tag: "CloseCombatBotch";
-        } | {
-            tag: "DefenseBotch";
-        } | {
-            tag: "MeleeCombatTechniques";
-        } | {
-            tag: "RangedCombatBotch";
-        } | {
-            tag: "RangedCombatDefenseBotch";
-        } | {
-            tag: "RangedCombatTechniques";
-        } | {
-            tag: "CombatSpecialAbilities";
-        } | {
-            tag: "Properties";
-        } | {
-            tag: "SpellBotch";
-        } | {
-            tag: "Services";
-        } | {
-            tag: "ProtectiveAndWardingCircles";
-        } | {
-            tag: "Elixirs";
-        } | {
-            tag: "StaffEnchantments";
-        } | {
-            tag: "FamiliarsTricks";
-        } | {
-            tag: "Curses";
-        } | {
-            tag: "ElvenMagicalSongs";
-        } | {
-            tag: "MagicalSpecialAbilities";
-        } | {
-            tag: "Cantrips";
-        } | {
-            tag: "Spells";
-        } | {
-            tag: "Rituals";
-        } | {
-            tag: "Aspects";
-        } | {
-            tag: "LiturgyBotch";
-        } | {
-            tag: "KarmaSpecialAbilities";
-        } | {
-            tag: "Blessings";
-        } | {
-            tag: "LiturgicalChants";
-        } | {
-            tag: "Ceremonies";
-        } | {
-            tag: "SocialStatuses";
-        } | {
-            tag: "Poisons";
-        } | {
-            tag: "Diseases";
-        } | {
-            tag: "HealingHerbs";
-        } | {
-            tag: "VisibilityModifier";
-        } | {
-            tag: "Demons";
-        } | {
-            tag: "Elementals";
-        } | {
-            tag: "Animals";
-        } | {
-            tag: "Familiars";
-        } | {
-            tag: "AnimalSpecialAbilities";
-        } | {
-            tag: "EquipmentPackages";
-        } | {
-            tag: "Items";
-        } | {
-            tag: "OptionalRules";
-        } | {
-            tag: "ImprovementCost";
-            /**
-             * 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: {
-                tag: "Attributes";
-            } | {
-                tag: "Skills";
-            };
-            /**
-             * 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;
-        };
-        /**
-         * All translations for the entry, identified by IETF language tag (BCP47).
-         * @minProperties 1
-         */
-        translations: {
-            /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-             */
-            [localeId: string]: {
-                /**
-                 * The list's or table's caption.
-                 * @minLength 1
-                 */
-                caption: string;
-            };
-        };
-    };
+export declare type ReferenceListNode = {
+    source: ReferenceListNodeSource;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ReferenceListNodeTranslation>;
+};
+export declare type ReferenceListNodeSource = {
+    tag: "Attributes";
+} | {
+    tag: "QualityLevels";
+} | {
+    tag: "Conditions";
+} | {
+    tag: "States";
+} | {
+    tag: "ExperienceLevels";
+} | {
+    tag: "Races";
+} | {
+    tag: "Cultures";
+} | {
+    tag: "Professions";
+} | {
+    tag: "Advantages";
+} | {
+    tag: "Disadvantages";
+} | {
+    tag: "CombatTechniques";
+} | {
+    tag: "SpecialAbilities";
+} | {
+    tag: "PrimaryAttributes";
+} | {
+    tag: "DerivedCharacteristics";
+} | {
+    tag: "StartingAge";
+} | {
+    tag: "Archetypes";
+} | {
+    tag: "RequirementsForRoutineChecks";
+} | {
+    tag: "GeneralSpecialAbilities";
+} | {
+    tag: "FatePointSpecialAbilities";
+} | {
+    tag: "LanguagesAndScripts";
+} | {
+    tag: "CloseCombatBotch";
+} | {
+    tag: "DefenseBotch";
+} | {
+    tag: "MeleeCombatTechniques";
+} | {
+    tag: "RangedCombatBotch";
+} | {
+    tag: "RangedCombatDefenseBotch";
+} | {
+    tag: "RangedCombatTechniques";
+} | {
+    tag: "CombatSpecialAbilities";
+} | {
+    tag: "Properties";
+} | {
+    tag: "SpellBotch";
+} | {
+    tag: "Services";
+} | {
+    tag: "ProtectiveAndWardingCircles";
+} | {
+    tag: "Elixirs";
+} | {
+    tag: "StaffEnchantments";
+} | {
+    tag: "FamiliarsTricks";
+} | {
+    tag: "Curses";
+} | {
+    tag: "ElvenMagicalSongs";
+} | {
+    tag: "MagicalSpecialAbilities";
+} | {
+    tag: "Cantrips";
+} | {
+    tag: "Spells";
+} | {
+    tag: "Rituals";
+} | {
+    tag: "Aspects";
+} | {
+    tag: "LiturgyBotch";
+} | {
+    tag: "KarmaSpecialAbilities";
+} | {
+    tag: "Blessings";
+} | {
+    tag: "LiturgicalChants";
+} | {
+    tag: "Ceremonies";
+} | {
+    tag: "SocialStatuses";
+} | {
+    tag: "Poisons";
+} | {
+    tag: "Diseases";
+} | {
+    tag: "HealingHerbs";
+} | {
+    tag: "VisibilityModifier";
+} | {
+    tag: "Demons";
+} | {
+    tag: "Elementals";
+} | {
+    tag: "Animals";
+} | {
+    tag: "Familiars";
+} | {
+    tag: "AnimalSpecialAbilities";
+} | {
+    tag: "EquipmentPackages";
+} | {
+    tag: "Items";
+} | {
+    tag: "OptionalRules";
+} | {
+    tag: "ImprovementCost";
+    improvement_cost: ReferenceListNodeImprovementCostSource;
+};
+export declare 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 type ReferenceListNodeImprovementCostSourceTarget = {
+    tag: "Attributes";
+} | {
+    tag: "Skills";
+};
+export declare type ReferenceListNodeTranslation = {
+    /**
+     * Markdown-formatted text.
+     */
+    text: NonEmptyMarkdown;
 };
 /**
  * Generate the full text for a single entry as part of this core rule's text.
  */
-declare type ReferenceNode = {
-    tag: "DeriveOne";
-    source: {
-        id: CoreRuleDerivableContentIdentifier;
-    };
+export declare type ReferenceNode = {
+    id: CoreRuleDerivableContentIdentifier;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<CoreRule>;
-export {};

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

@@ -3,6 +3,10 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../_NonEmptyString.js";
+import { FocusRuleSubjectReference } from "../_SimpleReferences.js";
+import { Relevance } from "./_Rule.js";
 /**
  * @title Focus Rule
  */
@@ -14,11 +18,9 @@ export declare type FocusRule = {
      */
     id: number;
     /**
-     * The focus rule's subject's identifier.
-     * @integer
-     * @minimum 1
+     * The associated subject.
      */
-    subject_id: number;
+    subject: FocusRuleSubjectReference;
     /**
      * The focus rule's level.
      * @integer
@@ -26,29 +28,22 @@ export declare type FocusRule = {
      * @maximum 4
      */
     level: number;
+    relevance: Relevance;
     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 focus rule.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The description of the focus rule.
-             * @markdown
-             * @minLength 1
-             */
-            description: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<FocusRuleTranslation>;
+};
+export declare type FocusRuleTranslation = {
+    /**
+     * The name of the focus rule.
+     */
+    name: NonEmptyString;
+    /**
+     * The description of the focus rule.
+     */
+    description: NonEmptyMarkdown;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<FocusRule>;

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

@@ -1,6 +1,8 @@
 /**
  * @main Subject
  */
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
 /**
  * Subjects or Subject Areas are the categories of Focus Rules.
  * @title Subject
@@ -14,19 +16,13 @@ export declare type Subject = {
     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 subject.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<SubjectTranslation>;
+};
+export declare type SubjectTranslation = {
+    /**
+     * The subject.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Subject>;

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

@@ -3,6 +3,9 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../_NonEmptyString.js";
+import { Relevance } from "./_Rule.js";
 /**
  * @title Optional Rule
  */
@@ -23,44 +26,18 @@ export declare type OptionalRule = {
     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 optional rule.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The description of the optional rule.
-             * @markdown
-             * @minLength 1
-             */
-            description: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<OptionalRuleTranslation>;
 };
-/**
- * The relevance of the optional rule for Optolith. It may be that it influences
- * character creating but it may also just influnce the character sheet. If it
- * is linked to systems in Optolith, it may be specified if this rule has not
- * been implemented in Optolith yet.
- */
-declare type Relevance = {
-    tag: "Extraneous";
-} | {
-    tag: "Linked";
+export declare type OptionalRuleTranslation = {
+    /**
+     * The name of the optional rule.
+     */
+    name: NonEmptyString;
     /**
-     * Does the optional rule have an impact on character creation or character
-     * sheet and this effect has not been implemented in Optolith yet? If
-     * `true`, the optional rule cannot be activated.
+     * The description of the optional rule.
      */
-    isMissingImplementation?: boolean;
+    description: NonEmptyMarkdown;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<OptionalRule>;
-export {};

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

@@ -0,0 +1,19 @@
+/**
+ * The relevance of the rule for Optolith. It may be that it influences
+ * character creating but it may also just influnce the character sheet. If it
+ * is linked to systems in Optolith, it may be specified if this rule has not
+ * been implemented in Optolith yet.
+ */
+export declare type Relevance = {
+    tag: "Extraneous";
+} | {
+    tag: "Linked";
+    linked: LinkedRelevance;
+};
+export declare type LinkedRelevance = {
+    /**
+     * Does the optional rule have an impact on character creation or character
+     * sheet and this effect has not been implemented in Optolith yet?
+     */
+    is_missing_implementation: boolean;
+};

package/lib/types/rule/_Rule.js

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