optolith-database-schema 0.20.4 → 0.20.6

package/lib/types/_Prerequisite.d.ts

@@ -2,6 +2,30 @@
  * @title Prerequisites
  */
 import { Array, EnumCase, IncludeIdentifier, Integer, Object, String, TypeAlias, TypeArgument } from "tsondb/schema/def";
+export declare const RulePrerequisites: TypeAlias<"RulePrerequisites", IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"PlainPrerequisites", Array<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").EnumDecl<"PrerequisitesElement", {
+    Single: EnumCase<TypeArgument<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>;
+    Disjunction: EnumCase<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"PrerequisitesDisjunction", Object<{
+        list: import("tsondb/schema/def").MemberDecl<Array<TypeArgument<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>, true>;
+        display_option: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"DisplayOption", {
+            Hide: EnumCase<null>;
+            ReplaceWith: EnumCase<IncludeIdentifier<[], TypeAlias<"ReplacementDisplayOption", Object<{
+                sentence_type: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"SentenceType", {
+                    Standalone: EnumCase<null>;
+                    Connected: EnumCase<null>;
+                }, []>>, false>;
+                translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"ReplacementDisplayOptionTranslation", {
+                    replacement: import("tsondb/schema/def").MemberDecl<String, true>;
+                }>, true>;
+            }>, []>>>;
+        }, []>>, false>;
+    }>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>;
+    Group: EnumCase<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"PrerequisiteGroup", Object<{
+        list: import("tsondb/schema/def").MemberDecl<Array<TypeArgument<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>, true>;
+        translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"PrerequisiteGroupTranslation", {
+            text: import("tsondb/schema/def").MemberDecl<String, true>;
+        }>, true>;
+    }>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>;
+}, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>, []>;
 export declare const DerivedCharacteristicPrerequisites: TypeAlias<"DerivedCharacteristicPrerequisites", IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"PlainPrerequisites", Array<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").EnumDecl<"PrerequisitesElement", {
     Single: EnumCase<TypeArgument<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>;
     Disjunction: EnumCase<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"PrerequisitesDisjunction", Object<{

package/lib/types/_Prerequisite.js

@@ -4,7 +4,7 @@
 import { Array, EnumCase, GenEnum, GenIncludeIdentifier, GenTypeAlias, IncludeIdentifier, Integer, Object, Optional, Param, Required, String, TypeAlias, TypeArgument, } from "tsondb/schema/def";
 import { NestedTranslationMap } from "./Locale.js";
 import { DisplayOption } from "./prerequisites/DisplayOption.js";
-import { AdvantageDisadvantagePrerequisiteGroup, AnimistPowerPrerequisiteGroup, ArcaneTraditionPrerequisiteGroup, DerivedCharacteristicPrerequisiteGroup, EnhancementPrerequisiteGroup, GeneralPrerequisiteGroup, GeodeRitualPrerequisiteGroup, InfluencePrerequisiteGroup, LanguagePrerequisiteGroup, LiturgyPrerequisiteGroup, PersonalityTraitPrerequisiteGroup, ProfessionPrerequisiteGroup, PublicationPrerequisiteGroup, SpellworkPrerequisiteGroup, } from "./prerequisites/PrerequisiteGroups.js";
+import { AdvantageDisadvantagePrerequisiteGroup, AnimistPowerPrerequisiteGroup, ArcaneTraditionPrerequisiteGroup, DerivedCharacteristicPrerequisiteGroup, EnhancementPrerequisiteGroup, GeneralPrerequisiteGroup, GeodeRitualPrerequisiteGroup, InfluencePrerequisiteGroup, LanguagePrerequisiteGroup, LiturgyPrerequisiteGroup, PersonalityTraitPrerequisiteGroup, ProfessionPrerequisiteGroup, PublicationPrerequisiteGroup, RulePrerequisiteGroup, SpellworkPrerequisiteGroup, } from "./prerequisites/PrerequisiteGroups.js";
 const PrerequisiteGroup = GenTypeAlias(import.meta.url, {
     name: "PrerequisiteGroup",
     comment: "A prerequisite group has no influence on validation logic. It serves as a single unit for displaying purposes, where the source uses a prerequisites item that cannot be represented as a single prerequisite.",
@@ -71,6 +71,10 @@ const PrerequisitesForLevels = GenTypeAlias(import.meta.url, {
         minItems: 1,
     }),
 });
+export const RulePrerequisites = TypeAlias(import.meta.url, {
+    name: "RulePrerequisites",
+    type: () => GenIncludeIdentifier(PlainPrerequisites, [IncludeIdentifier(RulePrerequisiteGroup)]),
+});
 export const DerivedCharacteristicPrerequisites = TypeAlias(import.meta.url, {
     name: "DerivedCharacteristicPrerequisites",
     type: () => GenIncludeIdentifier(PlainPrerequisites, [

package/lib/types/prerequisites/PrerequisiteGroups.d.ts

@@ -1,4 +1,24 @@
 import { Enum, EnumCase, IncludeIdentifier } from "tsondb/schema/def";
+export declare const RulePrerequisiteGroup: Enum<"RulePrerequisiteGroup", {
+    Rule: EnumCase<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"RulePrerequisite", import("tsondb/schema/def").ObjectType<{
+        id: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], Enum<"ExtensionRuleIdentifier", {
+            FocusRule: EnumCase<import("tsondb/schema/def").ReferenceIdentifierType>;
+            OptionalRule: EnumCase<import("tsondb/schema/def").ReferenceIdentifierType>;
+        }, []>>, true>;
+        display_option: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], Enum<"DisplayOption", {
+            Hide: EnumCase<null>;
+            ReplaceWith: EnumCase<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ReplacementDisplayOption", import("tsondb/schema/def").ObjectType<{
+                sentence_type: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], Enum<"SentenceType", {
+                    Standalone: EnumCase<null>;
+                    Connected: EnumCase<null>;
+                }, []>>, false>;
+                translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"ReplacementDisplayOptionTranslation", {
+                    replacement: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").StringType, true>;
+                }>, true>;
+            }>, []>>>;
+        }, []>>, false>;
+    }>, []>>>;
+}, []>;
 export declare const DerivedCharacteristicPrerequisiteGroup: Enum<"DerivedCharacteristicPrerequisiteGroup", {
     Rule: EnumCase<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"RulePrerequisite", import("tsondb/schema/def").ObjectType<{
         id: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], Enum<"ExtensionRuleIdentifier", {

package/lib/types/prerequisites/PrerequisiteGroups.js

@@ -19,6 +19,12 @@ import { SocialStatusPrerequisite } from "./single/SocialStatusPrerequisite.js";
 import { StatePrerequisite } from "./single/StatePrerequisite.js";
 import { TextPrerequisite } from "./single/TextPrerequisite.js";
 import { BlessedTraditionPrerequisite, MagicalTraditionPrerequisite, } from "./single/TraditionPrerequisite.js";
+export const RulePrerequisiteGroup = Enum(import.meta.url, {
+    name: "RulePrerequisiteGroup",
+    values: () => ({
+        Rule: EnumCase({ type: IncludeIdentifier(RulePrerequisite) }),
+    }),
+});
 export const DerivedCharacteristicPrerequisiteGroup = Enum(import.meta.url, {
     name: "DerivedCharacteristicPrerequisiteGroup",
     values: () => ({

package/lib/types/rule/FocusRule.d.ts

@@ -3,6 +3,30 @@ export declare const FocusRule: Entity<"FocusRule", {
     subject: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, false>;
     level: import("tsondb/schema/def").MemberDecl<Integer, true>;
     isMissingImplementation: import("tsondb/schema/def").MemberDecl<Boolean, true>;
+    prerequisites: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"RulePrerequisites", IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").TypeAliasDecl<"PlainPrerequisites", import("tsondb/schema/def").ArrayType<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").EnumDecl<"PrerequisitesElement", {
+        Single: import("tsondb/schema/def").EnumCaseDecl<import("tsondb/schema/def").TypeArgumentType<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>;
+        Disjunction: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").TypeAliasDecl<"PrerequisitesDisjunction", Object<{
+            list: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ArrayType<import("tsondb/schema/def").TypeArgumentType<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>, true>;
+            display_option: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"DisplayOption", {
+                Hide: import("tsondb/schema/def").EnumCaseDecl<null>;
+                ReplaceWith: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ReplacementDisplayOption", Object<{
+                    sentence_type: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"SentenceType", {
+                        Standalone: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        Connected: import("tsondb/schema/def").EnumCaseDecl<null>;
+                    }, []>>, false>;
+                    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"ReplacementDisplayOptionTranslation", {
+                        replacement: import("tsondb/schema/def").MemberDecl<String, true>;
+                    }>, true>;
+                }>, []>>>;
+            }, []>>, false>;
+        }>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>;
+        Group: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").TypeAliasDecl<"PrerequisiteGroup", Object<{
+            list: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ArrayType<import("tsondb/schema/def").TypeArgumentType<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>, true>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"PrerequisiteGroupTranslation", {
+                text: import("tsondb/schema/def").MemberDecl<String, true>;
+            }>, true>;
+        }>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>;
+    }, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>, []>>, false>;
     src: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"PublicationRefs", import("tsondb/schema/def").ArrayType<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"PublicationRef", Object<{
         id: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;
         occurrences: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<string, {

package/lib/types/rule/FocusRule.js

@@ -1,5 +1,6 @@
 import { Boolean, Entity, IncludeIdentifier, Integer, Object, Optional, Required, String, } from "tsondb/schema/def";
 import { SubjectIdentifier } from "../_Identifier.js";
+import { RulePrerequisites } from "../_Prerequisite.js";
 import { NestedTranslationMap } from "../Locale.js";
 import { Errata } from "../source/_Erratum.js";
 import { src } from "../source/_PublicationRef.js";
@@ -19,6 +20,9 @@ export const FocusRule = Entity(import.meta.url, {
             comment: "Has the focus rule not been implemented in Optolith yet? This is also true if the focus rule does not (currently) apply to any Optolith feature.",
             type: Boolean(),
         }),
+        prerequisites: Optional({
+            type: IncludeIdentifier(RulePrerequisites),
+        }),
         src,
         translations: NestedTranslationMap(Required, "FocusRule", Object({
             name: Required({

package/lib/types/rule/OptionalRule.d.ts

@@ -1,6 +1,30 @@
 import { Boolean, Entity, IncludeIdentifier, Object, String } from "tsondb/schema/def";
 export declare const OptionalRule: Entity<"OptionalRule", {
     isMissingImplementation: import("tsondb/schema/def").MemberDecl<Boolean, true>;
+    prerequisites: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"RulePrerequisites", IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").TypeAliasDecl<"PlainPrerequisites", import("tsondb/schema/def").ArrayType<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").EnumDecl<"PrerequisitesElement", {
+        Single: import("tsondb/schema/def").EnumCaseDecl<import("tsondb/schema/def").TypeArgumentType<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>;
+        Disjunction: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").TypeAliasDecl<"PrerequisitesDisjunction", Object<{
+            list: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ArrayType<import("tsondb/schema/def").TypeArgumentType<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>, true>;
+            display_option: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"DisplayOption", {
+                Hide: import("tsondb/schema/def").EnumCaseDecl<null>;
+                ReplaceWith: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ReplacementDisplayOption", Object<{
+                    sentence_type: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"SentenceType", {
+                        Standalone: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        Connected: import("tsondb/schema/def").EnumCaseDecl<null>;
+                    }, []>>, false>;
+                    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"ReplacementDisplayOptionTranslation", {
+                        replacement: import("tsondb/schema/def").MemberDecl<String, true>;
+                    }>, true>;
+                }>, []>>>;
+            }, []>>, false>;
+        }>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>;
+        Group: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").TypeAliasDecl<"PrerequisiteGroup", Object<{
+            list: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ArrayType<import("tsondb/schema/def").TypeArgumentType<import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>>>, true>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"PrerequisiteGroupTranslation", {
+                text: import("tsondb/schema/def").MemberDecl<String, true>;
+            }>, true>;
+        }>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>;
+    }, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>>, [T: import("tsondb/schema/def").TypeParameter<"T", import("tsondb/schema/def").Type>]>>, []>>, false>;
     src: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"PublicationRefs", import("tsondb/schema/def").ArrayType<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"PublicationRef", Object<{
         id: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;
         occurrences: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<string, {

package/lib/types/rule/OptionalRule.js

@@ -1,4 +1,5 @@
 import { Boolean, Entity, IncludeIdentifier, Object, Optional, Required, String, } from "tsondb/schema/def";
+import { RulePrerequisites } from "../_Prerequisite.js";
 import { NestedTranslationMap } from "../Locale.js";
 import { Errata } from "../source/_Erratum.js";
 import { src } from "../source/_PublicationRef.js";
@@ -10,6 +11,9 @@ export const OptionalRule = Entity(import.meta.url, {
             comment: "Has the optional rule not been implemented in Optolith yet? This is also true if the optional rule does not (currently) apply to any Optolith feature.",
             type: Boolean(),
         }),
+        prerequisites: Optional({
+            type: IncludeIdentifier(RulePrerequisites),
+        }),
         src,
         translations: NestedTranslationMap(Required, "OptionalRule", Object({
             name: Required({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.20.4",
+  "version": "0.20.6",
   "description": "Definitions and utilities for the flat-file database of Optolith, a character creation tool for the Pen and Paper RPG “The Dark Eye 5”, and its external integrations into other software.",
   "keywords": [
     "tde",
@@ -38,7 +38,7 @@
   "license": "MPL-2.0",
   "dependencies": {
     "@optolith/helpers": "^0.2.2",
-    "tsondb": "^0.12.0",
+    "tsondb": "^0.12.2",
     "yaml": "^2.8.1"
   },
   "devDependencies": {