optolith-database-schema 0.0.3 → 0.1.1

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).