optolith-database-schema 0.0.4 → 0.1.2

package/lib/types/_Prerequisite.d.ts

@@ -3,262 +3,313 @@
  */
 import { Identifier } from "./_Identifier";
 import { BinarySex } from "./_Sex";
-/**
- * @title Single Prerequisites
- */
-export declare namespace Single {
-    namespace DisplayOption {
-        /**
-         * @title Display Option
-         */
-        type T = {
-            tag: "Hide";
-        } | {
-            tag: "ReplaceWith";
+export declare namespace Prerequisite {
+    /**
+     * @title Single Prerequisites
+     */
+    export namespace Single {
+        namespace DisplayOption {
             /**
-             * All translations for the entry, identified by IETF language tag (BCP47).
-             * @minProperties 1
+             * @title Display Option
              */
-            value: {
+            type T = {
+                tag: "Hide";
+            } | {
+                tag: "ReplaceWith";
                 /**
-                 * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+                 * All translations for the entry, identified by IETF language tag (BCP47).
+                 * @minProperties 1
                  */
-                [localeId: string]: string;
+                translations: {
+                    /**
+                     * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+                     */
+                    [localeId: string]: string;
+                };
             };
-        };
-    }
-    namespace Sex {
-        /**
-         * Requires a specific sex.
-         * @title Sex Prerequisite
-         */
-        type T = {
-            tag: "Sex";
-            id: BinarySex;
-            display_option?: DisplayOption.T;
-        };
-    }
-    namespace Race {
-        /**
-         * Requires a specific culture or one of a specific set of cultures.
-         * @title Race Prerequisite
-         */
-        export type T = {
-            tag: "Culture";
-            id: Identifier;
-            active: boolean;
-            display_option?: DisplayOption.T;
-        };
-        type Identifier = SingleIdentifier | MultipleIdentifiers;
-        /**
-         * @minimum 1
-         */
-        type SingleIdentifier = number;
-        /**
-         * @minItems 2
-         */
-        type MultipleIdentifiers = SingleIdentifier[];
-        export {};
-    }
-    namespace Culture {
-        /**
-         * Requires a specific race or one of a specific set of races. You can also
-         * provide an object to say whether the hero must meet one of the races or
-         * if the entry does not allow one of the races.
-         * @title Culture Prerequisite
-         */
-        export type T = {
-            tag: "Culture";
-            id: Identifier;
-            display_option?: DisplayOption.T;
-        };
-        type Identifier = SingleIdentifier | MultipleIdentifiers;
-        /**
-         * @minimum 1
-         */
-        type SingleIdentifier = number;
-        /**
-         * @minItems 2
-         */
-        type MultipleIdentifiers = SingleIdentifier[];
-        export {};
-    }
-    namespace Rule {
-        /**
-         * @title Rule Prerequisite
-         */
-        export type T = {
-            tag: "Rule";
-            id: Identifier;
-            display_option?: DisplayOption.T;
-        };
-        type Identifier = {
-            tag: "FocusRule";
+        }
+        namespace Sex {
             /**
-             * @integer
-             * @minimum 1
+             * Requires a specific sex.
+             * @title Sex Prerequisite
              */
-            value: number;
-        } | {
-            tag: "OptionalRule";
+            type T = {
+                tag: "Sex";
+                id: BinarySex;
+                display_option?: DisplayOption.T;
+            };
+        }
+        namespace Race {
             /**
-             * @integer
-             * @minimum 1
+             * Requires a specific culture or one of a specific set of cultures.
+             * @title Race Prerequisite
              */
-            value: number;
-        };
-        export {};
-    }
-    namespace Publication {
-        /**
-         * @title Publication Prerequisite
-         */
-        type T = {
-            tag: "Publication";
+            export type T = {
+                tag: "Culture";
+                id: Identifier;
+                active: boolean;
+                display_option?: DisplayOption.T;
+            };
+            type Identifier = SingleIdentifier | MultipleIdentifiers;
             /**
-             * @integer
              * @minimum 1
              */
-            id: number;
-            display_option?: DisplayOption.T;
-        };
-    }
-    namespace PrimaryAttribute {
-        /**
-         * @title Primary Attribute Prerequisite
-         */
-        type T = {
-            tag: "PrimaryAttribute";
+            type SingleIdentifier = number;
             /**
-             * Is the required primary attribute for spellcasters or blessed ones?
+             * @minItems 2
              */
-            category: Category;
+            type MultipleIdentifiers = SingleIdentifier[];
+            export {};
+        }
+        namespace Culture {
             /**
-             * Required value of the attribute
-             * @integer
-             * @minimum 9
+             * Requires a specific race or one of a specific set of races. You can also
+             * provide an object to say whether the hero must meet one of the races or
+             * if the entry does not allow one of the races.
+             * @title Culture Prerequisite
              */
-            value: number;
-            display_option?: DisplayOption.T;
-        };
-        type Category = {
-            tag: "Blessed";
-        } | {
-            tag: "Magical";
-        };
-    }
-    namespace Pact {
-        /**
-         * Requires a specific pact.
-         * @title Pact Prerequisite
-         */
-        type T = {
-            tag: "Pact";
+            export type T = {
+                tag: "Culture";
+                id: Identifier;
+                display_option?: DisplayOption.T;
+            };
+            type Identifier = SingleIdentifier | MultipleIdentifiers;
             /**
-             * The required pact category's identifier.
-             * @integer
              * @minimum 1
              */
-            category_id: number;
+            type SingleIdentifier = number;
             /**
-             * The required domains' identifiers.
+             * @minItems 2
              */
-            domain_id?: DomainId[];
+            type MultipleIdentifiers = SingleIdentifier[];
+            export {};
+        }
+        namespace Rule {
             /**
-             * The required pact level.
-             * @integer
-             * @minimum 1
+             * @title Rule Prerequisite
              */
-            level?: number;
-            display_option?: DisplayOption.T;
-        };
-        /**
-         * A domain's identifier.
-         * @integer
-         * @minimum 1
-         */
-        type DomainId = number;
-    }
-    namespace SocialStatus {
-        /**
-         * Requires a minimum social status.
-         * @title Social Status Prerequisite
-         */
-        type T = {
-            tag: "SocialStatus";
+            export type T = {
+                tag: "Rule";
+                id: Identifier;
+                display_option?: DisplayOption.T;
+            };
+            type Identifier = {
+                tag: "FocusRule";
+                /**
+                 * @integer
+                 * @minimum 1
+                 */
+                value: number;
+            } | {
+                tag: "OptionalRule";
+                /**
+                 * @integer
+                 * @minimum 1
+                 */
+                value: number;
+            };
+            export {};
+        }
+        namespace Publication {
             /**
-             * The minimum social status' identifier.
-             * @integer
-             * @minimum 2
-             * @maximum 5
+             * @title Publication Prerequisite
              */
-            id: number;
-            display_option?: DisplayOption.T;
-        };
-    }
-    namespace Influence {
-        /**
-         * @title Influence Prerequisite
-         */
-        type T = {
-            tag: "Influence";
+            type T = {
+                tag: "Publication";
+                /**
+                 * @integer
+                 * @minimum 1
+                 */
+                id: number;
+                display_option?: DisplayOption.T;
+            };
+        }
+        namespace PrimaryAttribute {
             /**
-             * The influence's identifier.
-             * @integer
-             * @minimum 1
+             * @title Primary Attribute Prerequisite
              */
-            id: number;
+            type T = {
+                tag: "PrimaryAttribute";
+                /**
+                 * Is the required primary attribute for spellcasters or blessed ones?
+                 */
+                category: Category;
+                /**
+                 * Required value of the attribute
+                 * @integer
+                 * @minimum 9
+                 */
+                value: number;
+                display_option?: DisplayOption.T;
+            };
+            type Category = {
+                tag: "Blessed";
+            } | {
+                tag: "Magical";
+            };
+        }
+        namespace Pact {
             /**
-             * If the referenced influence must or must not be chosen.
+             * Requires a specific pact.
+             * @title Pact Prerequisite
              */
-            active: boolean;
-            display_option?: DisplayOption.T;
-        };
-    }
-    namespace Rated {
-        /**
-         * @title Rated Prerequisite
-         */
-        type T = {
-            tag: "Rated";
+            type T = {
+                tag: "Pact";
+                /**
+                 * The required pact category's identifier.
+                 * @integer
+                 * @minimum 1
+                 */
+                category_id: number;
+                /**
+                 * The required domains' identifiers.
+                 */
+                domain_id?: DomainId[];
+                /**
+                 * The required pact level.
+                 * @integer
+                 * @minimum 1
+                 */
+                level?: number;
+                display_option?: DisplayOption.T;
+            };
             /**
-             * The rated entry's identifier.
+             * A domain's identifier.
              * @integer
              * @minimum 1
              */
-            id: Identifier.Group.Rated;
+            type DomainId = number;
+        }
+        namespace SocialStatus {
             /**
-             * The required minimum value.
-             * @integer
-             * @minimum 0
+             * Requires a minimum social status.
+             * @title Social Status Prerequisite
              */
-            value: number;
-            display_option?: DisplayOption.T;
-        };
-    }
-    namespace Enhancement {
-        /**
-         * Requires a specific enhancement from a skill.
-         * @title Enhancement Prerequisite
-         */
-        type T = {
-            tag: "Enhancement";
+            type T = {
+                tag: "SocialStatus";
+                /**
+                 * The minimum social status' identifier.
+                 * @integer
+                 * @minimum 2
+                 * @maximum 5
+                 */
+                id: number;
+                display_option?: DisplayOption.T;
+            };
+        }
+        namespace Influence {
             /**
-             * The required skill's identifier.
+             * @title Influence Prerequisite
              */
-            skill: {
-                tag: SkillCategoryWithEnhancements;
+            type T = {
+                tag: "Influence";
                 /**
-                 * The skill's identifier.
+                 * The influence's identifier.
                  * @integer
                  * @minimum 1
                  */
                 id: number;
+                /**
+                 * If the referenced influence must or must not be chosen.
+                 */
+                active: boolean;
+                display_option?: DisplayOption.T;
+            };
+        }
+        namespace Activatable {
+            /**
+             * Requires a specific advantage, disadvantage, special ability.
+             * @title Activatable Prerequisite
+             */
+            type T = {
+                tag: "Activatable";
+                /**
+                 * The activatable entry's identifier.
+                 * @integer
+                 * @minimum 1
+                 */
+                id: Identifier.Group.Activatable;
+                /**
+                 * If the required entry should be required to be active or inactive.
+                 */
+                active: boolean;
+                /**
+                 * The required minimum level of the entry.
+                 * @integer
+                 * @minimum 1
+                 */
+                level?: number;
+                display_option?: DisplayOption.T;
+            };
+        }
+        namespace Rated {
+            /**
+             * @title Rated Prerequisite
+             */
+            type T = {
+                tag: "Rated";
+                /**
+                 * The rated entry's identifier.
+                 * @integer
+                 * @minimum 1
+                 */
+                id: Identifier.Group.Rated;
+                /**
+                 * The required minimum value.
+                 * @integer
+                 * @minimum 0
+                 */
+                value: number;
+                display_option?: DisplayOption.T;
+            };
+        }
+        namespace Enhancement {
+            /**
+             * Requires a specific enhancement from a skill.
+             * @title Enhancement Prerequisite
+             */
+            type T = {
+                tag: "Enhancement";
+                /**
+                 * The required skill's identifier.
+                 */
+                skill: {
+                    tag: SkillCategoryWithEnhancements;
+                    /**
+                     * The skill's identifier.
+                     * @integer
+                     * @minimum 1
+                     */
+                    id: number;
+                };
+                /**
+                 * The required enhancement's identifier.
+                 */
+                enhancement: {
+                    /**
+                     * The enhancement's identifier.
+                     * @integer
+                     * @minimum 1
+                     */
+                    id: number;
+                };
+                display_option?: DisplayOption.T;
             };
+            enum SkillCategoryWithEnhancements {
+                Spell = "Spell",
+                Ritual = "Ritual",
+                LiturgicalChant = "LiturgicalChant",
+                Ceremony = "Ceremony"
+            }
+        }
+        namespace EnhancementInternal {
             /**
-             * The required enhancement's identifier.
+             * Requires a specific enhancement from a skill. This can only be used by an
+             * enhancement to require another enhancement from the same skill.
+             * @title Internal Enhancement Prerequisite
              */
-            enhancement: {
+            type T = {
+                tag: "EnhancementInternal";
                 /**
                  * The enhancement's identifier.
                  * @integer
@@ -266,101 +317,97 @@ export declare namespace Single {
                  */
                 id: number;
             };
-            display_option?: DisplayOption.T;
-        };
-        enum SkillCategoryWithEnhancements {
-            Spell = "Spell",
-            Ritual = "Ritual",
-            LiturgicalChant = "LiturgicalChant",
-            Ceremony = "Ceremony"
+        }
+        namespace Ineligible {
+            /**
+             * This is a placeholder for required things that can never happen with the
+             * current set of crunch elements and rules, e. g. if a race is required
+             * that does not yet exist as a crunch element.
+             *
+             * A display option must be set.
+             * @title Ineligible Prerequisite
+             */
+            type T = {
+                tag: "Ineligible";
+                display_option: DisplayOption.T;
+            };
         }
     }
-    namespace EnhancementInternal {
-        /**
-         * Requires a specific enhancement from a skill. This can only be used by an
-         * enhancement to require another enhancement from the same skill.
-         * @title Internal Enhancement Prerequisite
-         */
-        type T = {
-            tag: "EnhancementInternal";
+    /**
+     * @title Grouped Prerequisites
+     */
+    namespace Group {
+        type DerivedCharacteristic = Single.Rule.T;
+        type Publication = Single.Publication.T;
+        type ArcaneTradition = Single.Sex.T | Single.Culture.T;
+        type Spellwork = Single.Rule.T | Single.Rated.T;
+        type Liturgy = Single.Rule.T;
+        type Language = Single.Ineligible.T | Single.Race.T | Single.Activatable.T;
+        type GeodeRitual = Single.Influence.T;
+        type Enhancement = Single.EnhancementInternal.T;
+    }
+    /**
+     * @title Prerequisite Collection Types
+     */
+    namespace Collection {
+        type Plain<T> = {
+            tag: "Plain";
             /**
-             * The enhancement's identifier.
-             * @integer
-             * @minimum 1
+             * @minItems 1
+             */
+            value: T[];
+        };
+        type ByLevel<T> = {
+            tag: "Plain";
+            /**
+             * @minItems 1
+             */
+            value: T[];
+        } | {
+            tag: "ByLevel";
+            /**
+             * @minItems 1
              */
-            id: number;
+            value: {
+                /**
+                 * @integer
+                 * @minimum 1
+                 */
+                level: number;
+                prerequisites: T[];
+            }[];
         };
     }
-}
-/**
- * @title Grouped Prerequisites
- */
-declare namespace Group {
-    type DerivedCharacteristic = Single.Rule.T;
-    type Publication = Single.Publication.T;
-    type ArcaneTradition = Single.Sex.T | Single.Culture.T;
-    type Spellwork = Single.Rule.T | Single.Rated.T;
-    type Liturgy = Single.Rule.T;
-    type GeodeRitual = Single.Influence.T;
-    type Enhancement = Single.EnhancementInternal.T;
-}
-/**
- * @title Prerequisite Collection Types
- */
-declare namespace Collection {
-    type Plain<T> = {
-        tag: "Plain";
+    /**
+     * @title Grouped Prerequisite Collections
+     */
+    export namespace GroupCollection {
+        type DerivedCharacteristic = Collection.Plain<Group.DerivedCharacteristic>;
+        type Publication = Collection.Plain<Group.Publication>;
         /**
-         * @minItems 1
+         * @title Arcane Tradition Prerequisites
          */
-        value: T[];
-    };
-    type ByLevel<T> = {
-        tag: "Plain";
+        type ArcaneTradition = Collection.Plain<Group.ArcaneTradition>;
         /**
-         * @minItems 1
+         * @title Spellwork Prerequisites
          */
-        value: T[];
-    } | {
-        tag: "ByLevel";
+        type Spellwork = Collection.Plain<Group.Spellwork>;
         /**
-         * @minItems 1
+         * @title Liturgy Prerequisites
          */
-        value: {
-            /**
-             * @integer
-             * @minimum 1
-             */
-            level: number;
-            prerequisites: T[];
-        }[];
-    };
-}
-/**
- * @title Grouped Prerequisite Collections
- */
-export declare namespace GroupCollection {
-    type DerivedCharacteristic = Collection.Plain<Group.DerivedCharacteristic>;
-    type Publication = Collection.Plain<Group.Publication>;
-    /**
-     * @title Arcane Tradition Prerequisites
-     */
-    type ArcaneTradition = Collection.Plain<Group.ArcaneTradition>;
-    /**
-     * @title Spellwork Prerequisites
-     */
-    type Spellwork = Collection.Plain<Group.Spellwork>;
-    /**
-     * @title Liturgy Prerequisites
-     */
-    type Liturgy = Collection.Plain<Group.Liturgy>;
-    /**
-     * @title Geode Ritual Prerequisites
-     */
-    type GeodeRitual = Collection.Plain<Group.GeodeRitual>;
-    /**
-     * @title Enhancement Prerequisites
-     */
-    type Enhancement = Collection.Plain<Group.Enhancement>;
+        type Liturgy = Collection.Plain<Group.Liturgy>;
+        /**
+         * @title Language Prerequisites
+         */
+        type Language = Collection.ByLevel<Group.Language>;
+        /**
+         * @title Geode Ritual Prerequisites
+         */
+        type GeodeRitual = Collection.Plain<Group.GeodeRitual>;
+        /**
+         * @title Enhancement Prerequisites
+         */
+        type Enhancement = Collection.Plain<Group.Enhancement>;
+    }
+    export {};
 }
-export {};