optolith-database-schema 0.0.2 → 0.1.0

package/CHANGELOG.md

@@ -2,6 +2,52 @@
 
 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)
+
+
+### Bug Fixes
+
+* broken markdown newlines ([87c5ff2](https://github.com/elyukai/optolith-database-schema/commit/87c5ff243c6df1a9dd966167c85dd41b45c36369))
+* cost map should allow different translations ([f65683f](https://github.com/elyukai/optolith-database-schema/commit/f65683fc45f2c9f16d1571ec9fcbc449eee042b1))
+
+### [0.0.3](https://github.com/elyukai/optolith-database-schema/compare/v0.0.2...v0.0.3) (2022-03-05)
+
+
+### Features
+
+* blessings ([8586a40](https://github.com/elyukai/optolith-database-schema/commit/8586a4026615ff6ebdc6cfb1e988d71828e5cd23))
+* cantrips ([50397e8](https://github.com/elyukai/optolith-database-schema/commit/50397e83c9322dd36ef0cd28d2924128a6133a27))
+* pact categories ([7b9cbc6](https://github.com/elyukai/optolith-database-schema/commit/7b9cbc66a5f13b40536d03a90f726fd9aff8c15a))
+
+
+### Bug Fixes
+
+* liturgies do not have properties ([9b2c41d](https://github.com/elyukai/optolith-database-schema/commit/9b2c41dd9996abeac627b652cdb6ce0226760f2a))
+
 ### [0.0.2](https://github.com/elyukai/optolith-database-schema/compare/v0.0.1...v0.0.2) (2022-03-05)
 
 

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/Blessing.d.ts

@@ -0,0 +1,124 @@
+/**
+ * @main Blessing
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Duration, TargetCategory } from "./_ActivatableSkill";
+/**
+ * @title Blessing
+ */
+export declare type Blessing = {
+    /**
+     * The blessing's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Measurable parameters of a blessing.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory.T;
+    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 blessing.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description.
+             * @markdown
+             * @minLength 1
+             */
+            effect: string;
+            /**
+             * @deprecated
+             */
+            range: string;
+            /**
+             * @deprecated
+             */
+            duration: string;
+            /**
+             * @deprecated
+             */
+            target: string;
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a blessing.
+ */
+declare type PerformanceParameters = {
+    range: {
+        tag: "Self";
+    } | {
+        tag: "Touch";
+    } | {
+        tag: "Fixed";
+        /**
+         * The range in steps/m.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    };
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * The (unitless) duration.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The duration unit.
+         */
+        unit: Duration.Unit;
+    } | {
+        tag: "Indefinite";
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * A description of the duration.
+                 */
+                description: {
+                    /**
+                     * The full description of the duration.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of the duration for use in small areas
+                     * (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+};
+export {};

package/lib/types/Blessing.js

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

package/lib/types/Cantrip.d.ts

@@ -0,0 +1,220 @@
+/**
+ * @main Spell
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Duration, Effect, TargetCategory } from "./_ActivatableSkill";
+import { Enhancements } from "./_Enhancements";
+import { ImprovementCost } from "./_ImprovementCost";
+/**
+ * @title Spell
+ */
+export declare type Spell = {
+    /**
+     * The spell's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Measurable parameters of a spell.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory.T;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    /**
+     * A note specifying the dissemination of the cantrip in different traditions.
+     * Sometimes a cantrip is exclusively available to one or more specific
+     * traditions, but usually one the academies and traditions are listed the
+     * cantrip is most commonly teached in.
+     */
+    note: {
+        tag: "Exclusive";
+        /**
+         * The traditions the cantrip is exclusively available to.
+         * @minItems 1
+         * @uniqueItems
+         */
+        traditions: {
+            /**
+             * The magical tradition's identifier.
+             * @integer
+             * @minimum 2
+             */
+            id: number;
+        }[];
+    } | {
+        tag: "Common";
+        /**
+         * The academies and traditions the cantrip is commonly teached in.
+         * @minItems 1
+         * @uniqueItems
+         */
+        list: CommonNote[];
+    };
+    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 spell.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description may be either a plain text or a text that is
+             * divided by a list of effects for each quality level. It may also be a
+             * list for each two quality levels.
+             */
+            effect: Effect.T;
+            /**
+             * @deprecated
+             */
+            casting_time: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            range: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            target: string;
+            errata?: Errata;
+        };
+    };
+    enhancements?: Enhancements;
+};
+/**
+ * Measurable parameters of a blessing.
+ */
+declare type PerformanceParameters = {
+    range: {
+        tag: "Self";
+    } | {
+        tag: "Touch";
+    } | {
+        tag: "Fixed";
+        /**
+         * The range in steps/m.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * If `true`, the range is a radius.
+         */
+        is_radius?: true;
+    };
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * If `true`, the duration is a maximum duration.
+         */
+        is_maximum?: true;
+        /**
+         * The (unitless) duration.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The duration unit.
+         */
+        unit: Duration.Unit;
+    } | {
+        tag: "DuringLovemaking";
+        /**
+         * The duration in rounds.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    } | {
+        tag: "Indefinite";
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * A description of the duration.
+                 */
+                description: {
+                    /**
+                     * The full description of the duration.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of the duration for use in small areas
+                     * (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+};
+export declare type CommonNote = {
+    tag: "Academy";
+    /**
+     * The academy's curriculum identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+} | {
+    tag: "Tradition";
+    /**
+     * The magical tradition's identifier.
+     * @integer
+     * @minimum 2
+     */
+    id: number;
+};
+export {};

package/lib/types/Cantrip.js

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

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
@@ -34,12 +34,6 @@ export declare type Ceremony = {
      * The target category – the kind of creature or object – the skill affects.
      */
     target: TargetCategory.T;
-    /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
-     */
-    property_id: number;
     /**
      * The tradition(s) the ceremony is available for. Note that general aspects
      * do not have an associated tradition and thus need to be defined in a
@@ -51,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
@@ -34,12 +34,6 @@ export declare type LiturgicalChant = {
      * The target category – the kind of creature or object – the skill affects.
      */
     target: TargetCategory.T;
-    /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
-     */
-    property_id: number;
     /**
      * The tradition(s) the liturgical chant is available for. Note that general
      * aspects do not have an associated tradition and thus need to be defined in
@@ -51,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).