optolith-database-schema 0.0.4 → 0.1.2

package/CHANGELOG.md

@@ -2,6 +2,45 @@
 
 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.2](https://github.com/elyukai/optolith-database-schema/compare/v0.1.1...v0.1.2) (2022-03-09)
+
+
+### Bug Fixes
+
+* output for namespaced imports ([0bf0c9d](https://github.com/elyukai/optolith-database-schema/commit/0bf0c9d8713e0449342b2b01309eb38b3b1013a7))
+
+### [0.1.1](https://github.com/elyukai/optolith-database-schema/compare/v0.1.0...v0.1.1) (2022-03-09)
+
+
+### Features
+
+* familiar's tricks ([f8f88c9](https://github.com/elyukai/optolith-database-schema/commit/f8f88c9ab3c3339c4e26830623052d09924c4102))
+* trade secrets ([c834c31](https://github.com/elyukai/optolith-database-schema/commit/c834c31de87ce830d34c4cf9c0f60dcfb5a4d3ca))
+
+## [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/FamiliarsTrick.d.ts

@@ -0,0 +1,333 @@
+/**
+ * @main FamiliarsTrick
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Duration } from "./_ActivatableSkill";
+/**
+ * @title Familiar's Trick
+ */
+export declare type FamiliarsTrick = {
+    /**
+     * The familiar's trick's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The animal types this trick is available to. Either it is available to all
+     * or only a list of specific animal types.
+     */
+    animal_types: {
+        tag: "All";
+    } | {
+        tag: "Specific";
+        /**
+         * The list of specific animal types.
+         * @minItems 1
+         */
+        list: {
+            /**
+             * The animal type's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        }[];
+    };
+    /**
+     * Measurable parameters of a familiar's trick.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The property of the trick.
+     */
+    property: {
+        tag: "Fixed";
+        /**
+         * The property's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: 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 property.
+                 */
+                description: {
+                    /**
+                     * The full description of the property.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of the property for use in small areas
+                     * (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+    /**
+     * The AP value the familiar has to pay for. It may also be that a specific is
+     * known by all familiar by default.
+     */
+    ap_value: {
+        tag: "Fixed";
+        /**
+         * The adventure points value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    } | {
+        tag: "Default";
+    };
+    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 familiar's trick.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description.
+             * @markdown
+             * @minLength 1
+             */
+            effect: string;
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a familiar's trick.
+ */
+declare type PerformanceParameters = {
+    tag: "OneTime";
+    cost: {
+        tag: "Fixed";
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The interval in which you have to pay the AE cost again.
+         */
+        interval?: Duration.UnitValue;
+        /**
+         * All translations for the entry, identified by IETF language tag
+         * (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * @minProperties 1
+             */
+            [localeId: string]: {
+                /**
+                 *
+                 */
+                per?: {
+                    /**
+                     * The full countable entity name.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * The compressed countable entity name.
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    } | {
+        tag: "All";
+        /**
+         * The minimum AE the familiar has to have.
+         * @integer
+         * @minimum 1
+         */
+        minimum?: 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 AE cost.
+                 */
+                description: {
+                    /**
+                     * The full description of the AE cost.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of the AE cost for use in small areas
+                     * (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * If the duration is the maximum duration, so it may end earlier.
+         */
+        is_maximum?: boolean;
+        /**
+         * The (unitless) duration.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The duration unit.
+         */
+        unit: Duration.Unit;
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * @minProperties 1
+             */
+            [localeId: string]: {
+                /**
+                 * A replacement string.
+                 */
+                replacement?: {
+                    /**
+                     * The full replacement string. It can contain `$1`, which is
+                     * going to be replaced with the generated duration string, so
+                     * additional information can be provided without duplicating
+                     * concrete numeric values.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed replacement string for use in small areas (e.g. on
+                     * character sheet). It can contain `$1`, which is going to be
+                     * replaced with the generated duration string, so additional
+                     * information can be provided without duplicating concrete
+                     * numeric values.
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    } | {
+        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;
+                };
+            };
+        };
+    };
+} | {
+    tag: "OneTimeInterval";
+    cost: {
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The duration granted/added by paying the given AE cost.
+         */
+        interval: Duration.UnitValue;
+    };
+} | {
+    tag: "Sustained";
+    cost: {
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The interval in which you have to pay the AE cost again.
+         */
+        interval: Duration.UnitValue;
+    };
+};
+export {};

package/lib/types/FamiliarsTrick.js

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

package/lib/types/FamiliarsTrick_AnimalType.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main AnimalType
+ */
+/**
+ * @title Animal Type
+ */
+export declare type AnimalType = {
+    /**
+     * The animal type'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 animal type name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/FamiliarsTrick_AnimalType.js

@@ -0,0 +1,4 @@
+/**
+ * @main AnimalType
+ */
+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).