optolith-database-schema 0.0.4 → 0.1.0

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.1.0](https://github.com/elyukai/optolith-database-schema/compare/v0.0.4...v0.1.0) (2022-03-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* extract tradition artifact enchantments and rituals
+* export all prerequisites in another namespace
+
+### Features
+
+* advantages and disadvantages base ([c025bb6](https://github.com/elyukai/optolith-database-schema/commit/c025bb6b8ee6dc3007c0af3b691852a864ebdea6))
+* animal shapes ([56b00f9](https://github.com/elyukai/optolith-database-schema/commit/56b00f90aff28f7cc8e8182f3f049d4593430113))
+* brews ([03a785d](https://github.com/elyukai/optolith-database-schema/commit/03a785d3cfa8fab2da0a8fe1ddb402b2b5a3ab7d))
+* continents ([95482db](https://github.com/elyukai/optolith-database-schema/commit/95482db5671440e24156c651ab094b4a10790223))
+* languages ([b85c4f1](https://github.com/elyukai/optolith-database-schema/commit/b85c4f1bcaf5199cd1501051c17b05a8b5178345))
+* patrons ([c7e9b6c](https://github.com/elyukai/optolith-database-schema/commit/c7e9b6cabdfdfca7d51eb6891bfb8b8b2973bbff))
+* pluralization categories type for user interface ([a434d53](https://github.com/elyukai/optolith-database-schema/commit/a434d53a47e0e50b129855aee8e0a5bc4b634d79))
+* scripts ([78a2e92](https://github.com/elyukai/optolith-database-schema/commit/78a2e92d72c0e2616948e9e2ccc1b51752be3b87))
+* special abilities base ([f935264](https://github.com/elyukai/optolith-database-schema/commit/f935264328d19b29b0e30a0b1907501c30a2d4c5))
+
+
+* export all prerequisites in another namespace ([4c09c3e](https://github.com/elyukai/optolith-database-schema/commit/4c09c3e3371beff4587327e40564866b397e311b))
+* extract tradition artifact enchantments and rituals ([58e06c6](https://github.com/elyukai/optolith-database-schema/commit/58e06c6925bb56ea854ad211efcf89f981e715b7))
+
 ### [0.0.4](https://github.com/elyukai/optolith-database-schema/compare/v0.0.3...v0.0.4) (2022-03-06)
 
 

package/lib/types/Advantage.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @main Advantage
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import * as Activatable from "./_Activatable";
+/**
+ * @title Advantage
+ */
+export declare type Advantage = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    ap_value: Activatable.AdventurePointsValue;
+    /**
+     * Does this advantage not count towards the maximum of AP to be spent
+     * on advantages?
+     */
+    has_no_maximum_spent_influence?: true;
+    /**
+     * Does this advantage exclusively applies to arcane spellworks but not
+     * to magical actions and applications?
+     */
+    is_exclusive_to_arcane_spellworks?: true;
+    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;
+            /**
+             * The range.
+             * @markdown
+             * @minLength 1
+             */
+            range?: string;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/Advantage.js

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

package/lib/types/ArcaneBardTradition.d.ts

@@ -1,7 +1,7 @@
 /**
  * @main ArcaneBardTradition
  */
-import { GroupCollection } from "./_Prerequisite";
+import { Prerequisite } from "./_Prerequisite";
 /**
  * @title Arcane Bard Tradition
  */
@@ -12,7 +12,7 @@ export declare type ArcaneBardTradition = {
      * @minimum 1
      */
     id: number;
-    prerequisites: GroupCollection.ArcaneTradition;
+    prerequisites: Prerequisite.GroupCollection.ArcaneTradition;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
      * @minProperties 1

package/lib/types/ArcaneDancerTradition.d.ts

@@ -1,7 +1,7 @@
 /**
  * @main ArcaneDancerTradition
  */
-import { GroupCollection } from "./_Prerequisite";
+import { Prerequisite } from "./_Prerequisite";
 /**
  * @title Arcane Dancer Tradition
  */
@@ -12,7 +12,7 @@ export declare type ArcaneDancerTradition = {
      * @minimum 1
      */
     id: number;
-    prerequisites: GroupCollection.ArcaneTradition;
+    prerequisites: Prerequisite.GroupCollection.ArcaneTradition;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
      * @minProperties 1

package/lib/types/Ceremony.d.ts

@@ -6,7 +6,7 @@ import { PublicationRefs } from "./source/_PublicationRef";
 import { Effect, SlowPerformanceParameters, TargetCategory } from "./_ActivatableSkill";
 import { Enhancements } from "./_Enhancements";
 import { ImprovementCost } from "./_ImprovementCost";
-import { GroupCollection } from "./_Prerequisite";
+import { Prerequisite } from "./_Prerequisite";
 import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck";
 /**
  * @title Ceremony
@@ -45,7 +45,7 @@ export declare type Ceremony = {
      * States which column is used to improve the skill.
      */
     improvement_cost: ImprovementCost;
-    prerequisites?: GroupCollection.Liturgy;
+    prerequisites?: Prerequisite.GroupCollection.Liturgy;
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).

package/lib/types/Continent.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @main Continent
+ */
+/**
+ * Continents are mostly referenced to in languages and scripts that occur on a
+ * specific continent.
+ * @title Continent
+ */
+export declare type Continent = {
+    /**
+     * The continent'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 continent name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/Continent.js

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

package/lib/types/DerivedCharacteristic.d.ts

@@ -2,7 +2,7 @@
  * @main DerivedCharacteristic
  */
 import { PublicationRefs } from "./source/_PublicationRef";
-import { GroupCollection } from "./_Prerequisite";
+import { Prerequisite } from "./_Prerequisite";
 /**
  * @title Derived Characteristic
  */
@@ -13,7 +13,7 @@ export declare type DerivedCharacteristic = {
      * @minimum 1
      */
     id: number;
-    prerequisites?: GroupCollection.DerivedCharacteristic;
+    prerequisites?: Prerequisite.GroupCollection.DerivedCharacteristic;
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).

package/lib/types/Disadvantage.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @main Disadvantage
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import * as Activatable from "./_Activatable";
+/**
+ * @title Disadvantage
+ */
+export declare type Disadvantage = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    ap_value: Activatable.AdventurePointsValue;
+    /**
+     * Does this disadvantage not count towards the maximum of AP to be granted by
+     * disadvantages?
+     */
+    has_no_maximum_spent_influence?: true;
+    /**
+     * Does this disadvantage exclusively applies to arcane spellworks but not
+     * to magical actions and applications?
+     */
+    is_exclusive_to_arcane_spellworks?: true;
+    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;
+            /**
+             * The range.
+             * @markdown
+             * @minLength 1
+             */
+            range?: string;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/Disadvantage.js

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

package/lib/types/LiturgicalChant.d.ts

@@ -6,7 +6,7 @@ import { PublicationRefs } from "./source/_PublicationRef";
 import { Effect, FastPerformanceParameters, TargetCategory } from "./_ActivatableSkill";
 import { Enhancements } from "./_Enhancements";
 import { ImprovementCost } from "./_ImprovementCost";
-import { GroupCollection } from "./_Prerequisite";
+import { Prerequisite } from "./_Prerequisite";
 import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck";
 /**
  * @title Liturgical Chant
@@ -45,7 +45,7 @@ export declare type LiturgicalChant = {
      * States which column is used to improve the skill.
      */
     improvement_cost: ImprovementCost;
-    prerequisites?: GroupCollection.Liturgy;
+    prerequisites?: Prerequisite.GroupCollection.Liturgy;
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).

package/lib/types/Patron.d.ts

@@ -0,0 +1,197 @@
+/**
+ * @main Patron
+ */
+import { ImprovementCost } from "./_ImprovementCost";
+/**
+ * @title Patron
+ */
+export declare type Patron = {
+    /**
+     * The patron's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The patron's category identifier.
+     * @integer
+     * @minimum 1
+     */
+    category_id: number;
+    /**
+     * The patron-specific skills.
+     */
+    skills: [SkillReference, SkillReference, SkillReference];
+    /**
+     * The patron is only available to a certain set of cultures. It may be
+     * available to all, it may be available to only specific ones (intersection)
+     * and it may be available to all except specific ones to the listed cultures
+     * (difference).
+     */
+    culture: {
+        tag: "All";
+    } | {
+        tag: "Intersection";
+        list: {
+            /**
+             * The culture's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        }[];
+    } | {
+        tag: "Difference";
+        list: {
+            /**
+             * The culture's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        }[];
+    };
+    /**
+     * The list of cultures where patrons from this category can be the primary
+     * patron of.
+     * @minItems 1
+     * @uniqueItems
+     */
+    primary_patron_cultures?: {
+        /**
+         * The culture's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    }[];
+    /**
+     * The patron-specific powers. Used by animist power Animal Powers I–III and
+     * should only be present on animal patrons.
+     */
+    powers?: [AnimalPowersLevel1, AnimalPowersLevel2, AnimalPowersLevel3];
+    /**
+     * The patron-specific AE cost. Used by several animist forces for animal
+     * patrons.
+     * @integer
+     * @minimum 2
+     * @multipleOf 2
+     */
+    ae_cost?: number;
+    /**
+     * The patron-specific improvement cost. Used by several animist forces for
+     * animal patrons.
+     */
+    improvement_cost?: ImprovementCost;
+    /**
+     * 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 patron.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};
+export declare type SkillReference = {
+    /**
+     * The skill's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type AnimalPowerLevel1 = {
+    tag: "Advantage";
+    /**
+     * The advantage's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * It grants a higher level of the advantage.
+     * @integer
+     * @minimum 2
+     */
+    level?: number;
+    /**
+     * It grants a specific general option of the advantage.
+     * @integer
+     * @minimum 1
+     */
+    option?: number;
+} | {
+    tag: "Skill";
+    /**
+     * The skill's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The points that gets added to the skill's rating.
+     * @integer
+     * @minimum 1
+     */
+    points: number;
+};
+/**
+ * @minItems 1
+ */
+export declare type AnimalPowersLevel1 = AnimalPowerLevel1[];
+export declare type AnimalPowerLevel2 = {
+    tag: "Combat";
+    /**
+     * The combat value.
+     */
+    id: {
+        tag: "Attack";
+    } | {
+        tag: "Parry";
+    } | {
+        tag: "RangedCombat";
+    } | {
+        tag: "Dodge";
+    } | {
+        tag: "DamagePoints";
+    } | {
+        tag: "Protection";
+    };
+    /**
+     * The value that gets added to the combat value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+};
+/**
+ * @minItems 1
+ */
+export declare type AnimalPowersLevel2 = AnimalPowerLevel2[];
+export declare type AnimalPowerLevel3 = {
+    tag: "Attribute";
+    /**
+     * The attribute's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The value that gets added to the attribute.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+};
+/**
+ * @minItems 1
+ */
+export declare type AnimalPowersLevel3 = AnimalPowerLevel3[];

package/lib/types/Patron.js

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

package/lib/types/PatronCategory.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @main PatronCategory
+ */
+/**
+ * @title Patron Category
+ */
+export declare type PatronCategory = {
+    /**
+     * The patron category's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The list of cultures where patrons from this category can be the primary
+     * patron of.
+     * @minItems 1
+     * @uniqueItems
+     */
+    primary_patron_cultures: {
+        /**
+         * The culture's identifier.
+         * @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 name of the patron category.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/PatronCategory.js

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

package/lib/types/Ritual.d.ts

@@ -6,7 +6,7 @@ import { PublicationRefs } from "./source/_PublicationRef";
 import { Effect, SlowPerformanceParameters, TargetCategory } from "./_ActivatableSkill";
 import { Enhancements } from "./_Enhancements";
 import { ImprovementCost } from "./_ImprovementCost";
-import { GroupCollection } from "./_Prerequisite";
+import { Prerequisite } from "./_Prerequisite";
 import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck";
 /**
  * @title Ritual
@@ -73,7 +73,7 @@ export declare type Ritual = {
      * States which column is used to improve the skill.
      */
     improvement_cost: ImprovementCost;
-    prerequisites?: GroupCollection.Spellwork;
+    prerequisites?: Prerequisite.GroupCollection.Spellwork;
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).

package/lib/types/Spell.d.ts

@@ -6,7 +6,7 @@ import { PublicationRefs } from "./source/_PublicationRef";
 import { Effect, FastPerformanceParameters, TargetCategory } from "./_ActivatableSkill";
 import { Enhancements } from "./_Enhancements";
 import { ImprovementCost } from "./_ImprovementCost";
-import { GroupCollection } from "./_Prerequisite";
+import { Prerequisite } from "./_Prerequisite";
 import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck";
 /**
  * @title Spell
@@ -73,7 +73,7 @@ export declare type Spell = {
      * States which column is used to improve the skill.
      */
     improvement_cost: ImprovementCost;
-    prerequisites?: GroupCollection.Spellwork;
+    prerequisites?: Prerequisite.GroupCollection.Spellwork;
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).