optolith-database-schema 0.26.3 → 0.26.5

package/CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [0.26.5](https://github.com/elyukai/optolith-database-schema/compare/v0.26.4...v0.26.5) (2025-12-29)
+
+
+### Features
+
+* add some display names ([6cb3f40](https://github.com/elyukai/optolith-database-schema/commit/6cb3f40f7e1cb43ec02fcb48030b72613d194701))
+
+
+### Bug Fixes
+
+* duplicate cost map translation identifier ([6fad16b](https://github.com/elyukai/optolith-database-schema/commit/6fad16bf98ede7dc3f41ec6afb153eb2ad4b9d84))
+
+## [0.26.4](https://github.com/elyukai/optolith-database-schema/compare/v0.26.3...v0.26.4) (2025-12-29)
+
+
+### Features
+
+* add object as skill check penalty ([f3ea105](https://github.com/elyukai/optolith-database-schema/commit/f3ea105280387cbfb70c988aecd4285fb9e91572)), closes [#101](https://github.com/elyukai/optolith-database-schema/issues/101)
+* add race as requirable select option ([e3bd65f](https://github.com/elyukai/optolith-database-schema/commit/e3bd65f71194c136130265d5bff24d9fe71f3dcc)), closes [#99](https://github.com/elyukai/optolith-database-schema/issues/99)
+* add rated option to enhancement prerequisite ([ae43d2a](https://github.com/elyukai/optolith-database-schema/commit/ae43d2ab12e9313260b96bac931a75e730d69423)), closes [#103](https://github.com/elyukai/optolith-database-schema/issues/103)
+* add sustained skill cost map ([1fd987d](https://github.com/elyukai/optolith-database-schema/commit/1fd987de4fe3b0a5e72eaa49f95252c9cb7e6cdb)), closes [#102](https://github.com/elyukai/optolith-database-schema/issues/102)
+* warding circle text is optional ([8a4903e](https://github.com/elyukai/optolith-database-schema/commit/8a4903ebdcd1e2e8c77a220cc272421913f42493)), closes [#105](https://github.com/elyukai/optolith-database-schema/issues/105)
+
 ## [0.26.3](https://github.com/elyukai/optolith-database-schema/compare/v0.26.2...v0.26.3) (2025-12-28)
 
 

package/gen/types.d.ts

@@ -4010,6 +4010,10 @@ export type RequirableSelectOptionIdentifier =
     kind: "General"
     General: GeneralSelectOption_ID
   }
+  | {
+    kind: "Race"
+    Race: Race_ID
+  }
   | {
     kind: "Skill"
     Skill: Skill_ID
@@ -4462,6 +4466,9 @@ export type SkillCheckPenalty =
   | {
     kind: "CreationDifficulty"
   }
+  | {
+    kind: "Object"
+  }
 
 export type FastPerformanceParameters =
   | {
@@ -4497,7 +4504,7 @@ export type OneTimeCost =
   }
   | {
     kind: "Map"
-    Map: CostMap
+    Map: OneTimeCostMap
   }
 
 export type SingleOneTimeCost =
@@ -4775,21 +4782,21 @@ export type MultipleOneTimeCosts = SingleOneTimeCost[]
  * 
  * This will generate the exact same string as seen above – given it is set for a spellwork and thus `AE` is used.
  */
-export interface CostMap {
+export interface OneTimeCostMap {
   /**
    * The possible costs and associated labels.
    */
-  options: CostMapOption[]
+  options: OneTimeCostMapOption[]
 
   /**
    * All translations for the entry, identified by IETF language tag (BCP47).
    */
   translations?: {
-    [localeId: string]: CostMapTranslation
+    [localeId: string]: OneTimeCostMapTranslation
   }
 }
 
-export interface CostMapTranslation {
+export interface OneTimeCostMapTranslation {
   /**
    * Place a string between the `for` and the grouped map option labels.
    */
@@ -4806,7 +4813,7 @@ export interface CostMapTranslation {
   replacement?: ResponsiveTextOptional
 }
 
-export interface CostMapOption {
+export interface OneTimeCostMapOption {
   /**
    * The full cost value for this option.
    */
@@ -4821,18 +4828,18 @@ export interface CostMapOption {
    * All translations for the entry, identified by IETF language tag (BCP47).
    */
   translations?: {
-    [localeId: string]: CostMapOptionTranslation
+    [localeId: string]: OneTimeCostMapOptionTranslation
   }
 }
 
-export interface CostMapOptionTranslation {
+export interface OneTimeCostMapOptionTranslation {
   /**
    * The description of the option for cost string generation.
    */
   label: ResponsiveTextOptional
 
   /**
-   * The description of the option if used standalone. Only used if different from `label`.
+   * The description of the option if used standalone (e.g. in an in-game tool where you can select how many AE you have to pay). Only used if different from `label`.
    */
   label_standalone?: ResponsiveTextOptional
 }
@@ -5267,6 +5274,10 @@ export type SustainedCost =
     kind: "NonModifiable"
     NonModifiable: NonModifiableSustainedCost
   }
+  | {
+    kind: "Map"
+    Map: SustainedCostMap
+  }
 
 export interface ModifiableSustainedCost {
   /**
@@ -5323,6 +5334,68 @@ export interface NonModifiableSustainedCostPerCountableTranslation {
   countable: ResponsiveText
 }
 
+/**
+ * A content that is `2/4/8/16 AE (activation) + 1/2/4/8 per 5 minutes for an item the size of a cup/chest/door/castle gate` can be represented as a cost map.
+ * 
+ * The `an item the size of a` would be the *list prefix* string, while the list of options would contain four options with the activation cost and the name.
+ */
+export interface SustainedCostMap {
+  /**
+   * The possible costs and associated labels.
+   */
+  options: SustainedCostMapOption[]
+
+  /**
+   * All translations for the entry, identified by IETF language tag (BCP47).
+   */
+  translations?: {
+    [localeId: string]: SustainedCostMapTranslation
+  }
+}
+
+export interface SustainedCostMapTranslation {
+  /**
+   * Place a string between the `for` and the grouped map option labels.
+   */
+  listPrefix?: ResponsiveTextOptional
+
+  /**
+   * Place a string after the grouped map option labels.
+   */
+  listSuffix?: ResponsiveTextOptional
+
+  /**
+   * If the string from the book cannot be generated using the default generation technique, use this string. All options still need to be inserted propertly, since it may be used by in-game tools to provide a selection to players.
+   */
+  replacement?: ResponsiveTextOptional
+}
+
+export interface SustainedCostMapOption {
+  /**
+   * The activation cost value for this option. The interval cost is always half of this value.
+   */
+  value: number
+
+  /**
+   * All translations for the entry, identified by IETF language tag (BCP47).
+   */
+  translations?: {
+    [localeId: string]: SustainedCostMapOptionTranslation
+  }
+}
+
+export interface SustainedCostMapOptionTranslation {
+  /**
+   * The description of the option for cost string generation.
+   */
+  label: ResponsiveTextOptional
+
+  /**
+   * The description of the option if used standalone (e.g. in an in-game tool where you can select how many AE you have to pay). Only used if different from `label`.
+   */
+  standaloneLabel?: ResponsiveTextOptional
+}
+
 export interface DurationForSustained {
   /**
    * The sustained skill can be active a maximum amount of time.
@@ -6856,6 +6929,10 @@ export type EnhancementPrerequisiteGroup =
     kind: "Enhancement"
     Enhancement: EnhancementPrerequisite
   }
+  | {
+    kind: "Rated"
+    Rated: RatedPrerequisite
+  }
 
 /**
  * Requires a specific enhancement from a skill.
@@ -13565,7 +13642,7 @@ export type MagicalSignCost =
   }
   | {
     kind: "Map"
-    Map: CostMap
+    Map: OneTimeCostMap
   }
 
 export interface ConstantMagicalSignCost {
@@ -14161,7 +14238,7 @@ export interface ProtectiveWardingCircleSpecialAbilityTranslation {
   /**
    * The rules for the warding circle variant.
    */
-  warding_circle: string
+  warding_circle?: string
 
   /**
    * The string to append to the generated AP value text.
@@ -17035,7 +17112,7 @@ export type GeodeRitualCost =
   }
   | {
     kind: "Map"
-    Map: CostMap
+    Map: OneTimeCostMap
   }
 
 export interface FixedGeodeRitualCost {

package/lib/types/Advantage.js

@@ -45,7 +45,7 @@ export const Advantage = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/AnimalDisease.js

@@ -25,7 +25,7 @@ If no causes are given, the disease is not communicable to intelligent creatures
         src,
         translations: NestedTranslationMap(Required, "AnimalDisease", DiseaseTranslation),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/AnimalType.js

@@ -11,7 +11,7 @@ export const AnimalType = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/ArcaneBardTradition.js

@@ -4,7 +4,7 @@ export const ArcaneBardTradition = Entity(import.meta.url, {
     name: "ArcaneBardTradition",
     namePlural: "ArcaneBardTraditions",
     type: ArcaneTraditionType("ArcaneBardTraditionTranslation"),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/ArcaneDancerTradition.js

@@ -4,7 +4,7 @@ export const ArcaneDancerTradition = Entity(import.meta.url, {
     name: "ArcaneDancerTradition",
     namePlural: "ArcaneDancerTraditions",
     type: ArcaneTraditionType("ArcaneDancerTraditionTranslation"),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Aspect.js

@@ -17,7 +17,7 @@ export const Aspect = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Attribute.js

@@ -20,7 +20,7 @@ export const Attribute = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Blessing.js

@@ -44,7 +44,7 @@ export const Blessing = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Cantrip.js

@@ -55,7 +55,7 @@ export const Cantrip = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Ceremony.d.ts

@@ -8,6 +8,7 @@ export declare const Ceremony: Entity<"Ceremony", {
         HigherOfSpiritAndToughness: import("tsondb/schema/def").EnumCaseDecl<null>;
         SummoningDifficulty: import("tsondb/schema/def").EnumCaseDecl<null>;
         CreationDifficulty: import("tsondb/schema/def").EnumCaseDecl<null>;
+        Object: import("tsondb/schema/def").EnumCaseDecl<null>;
     }, []>>, false>;
     parameters: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"SlowPerformanceParameters", {
         OneTime: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"SlowOneTimePerformanceParameters", IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], import("tsondb/schema/def").TypeAliasDecl<"OneTimePerformanceParameters", Object<{
@@ -133,11 +134,11 @@ export declare const Ceremony: Entity<"Ceremony", {
                         }>, true>;
                     }>, []>>>;
                 }, []>>>, []>>>;
-                Map: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"CostMap", Object<{
-                    options: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"CostMapOption", Object<{
+                Map: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"OneTimeCostMap", Object<{
+                    options: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"OneTimeCostMapOption", Object<{
                         value: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").IntegerType, true>;
                         permanent_value: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").IntegerType, false>;
-                        translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"CostMapOptionTranslation", {
+                        translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"OneTimeCostMapOptionTranslation", {
                             label: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ResponsiveTextOptional", Object<{
                                 full: import("tsondb/schema/def").MemberDecl<String, true>;
                                 compressed: import("tsondb/schema/def").MemberDecl<String, false>;
@@ -148,7 +149,7 @@ export declare const Ceremony: Entity<"Ceremony", {
                             }>, []>>, false>;
                         }>, false>;
                     }>, []>>>, true>;
-                    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"CostMapTranslation", {
+                    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"OneTimeCostMapTranslation", {
                         list_prepend: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ResponsiveTextOptional", Object<{
                             full: import("tsondb/schema/def").MemberDecl<String, true>;
                             compressed: import("tsondb/schema/def").MemberDecl<String, false>;
@@ -360,6 +361,35 @@ export declare const Ceremony: Entity<"Ceremony", {
                         }, []>>, true>;
                     }>, []>>, true>;
                 }>, []>>>;
+                Map: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"SustainedCostMap", Object<{
+                    options: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"SustainedCostMapOption", Object<{
+                        value: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").IntegerType, true>;
+                        translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"SustainedCostMapOptionTranslation", {
+                            label: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ResponsiveTextOptional", Object<{
+                                full: import("tsondb/schema/def").MemberDecl<String, true>;
+                                compressed: import("tsondb/schema/def").MemberDecl<String, false>;
+                            }>, []>>, true>;
+                            standaloneLabel: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ResponsiveTextOptional", Object<{
+                                full: import("tsondb/schema/def").MemberDecl<String, true>;
+                                compressed: import("tsondb/schema/def").MemberDecl<String, false>;
+                            }>, []>>, false>;
+                        }>, false>;
+                    }>, []>>>, true>;
+                    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"SustainedCostMapTranslation", {
+                        listPrefix: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ResponsiveTextOptional", Object<{
+                            full: import("tsondb/schema/def").MemberDecl<String, true>;
+                            compressed: import("tsondb/schema/def").MemberDecl<String, false>;
+                        }>, []>>, false>;
+                        listSuffix: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ResponsiveTextOptional", Object<{
+                            full: import("tsondb/schema/def").MemberDecl<String, true>;
+                            compressed: import("tsondb/schema/def").MemberDecl<String, false>;
+                        }>, []>>, false>;
+                        replacement: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"ResponsiveTextOptional", Object<{
+                            full: import("tsondb/schema/def").MemberDecl<String, true>;
+                            compressed: import("tsondb/schema/def").MemberDecl<String, false>;
+                        }>, []>>, false>;
+                    }>, false>;
+                }>, []>>>;
             }, []>>, true>;
             range: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"Range", Object<{
                 value: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"RangeValue", {

package/lib/types/Ceremony.js

@@ -84,7 +84,7 @@ export const Ceremony = Entity(import.meta.url, {
             type: ChildEntities(Enhancement),
         }),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/CombatTechnique.js

@@ -39,7 +39,7 @@ export const CloseCombatTechnique = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",
@@ -114,7 +114,7 @@ export const RangedCombatTechnique = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Condition.js

@@ -28,7 +28,7 @@ export const Condition = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Continent.js

@@ -12,7 +12,7 @@ export const Continent = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Culture.js

@@ -93,7 +93,7 @@ export const Culture = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/DerivedCharacteristic.js

@@ -25,7 +25,7 @@ export const DerivedCharacteristic = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Disadvantage.js

@@ -46,7 +46,7 @@ export const Disadvantage = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Disease.js

@@ -17,7 +17,7 @@ export const Disease = Entity(import.meta.url, {
         src,
         translations: NestedTranslationMap(Required, "Disease", DiseaseTranslation),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/Element.js

@@ -11,7 +11,7 @@ export const Element = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/ExperienceLevel.js

@@ -40,7 +40,7 @@ export const ExperienceLevel = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/EyeColor.js

@@ -11,7 +11,7 @@ export const EyeColor = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/FamiliarsTrick.js

@@ -10,6 +10,8 @@ import { src } from "./source/_PublicationRef.js";
 export const FamiliarsTrick = Entity(import.meta.url, {
     name: "FamiliarsTrick",
     namePlural: "FamiliarsTricks",
+    displayName: "Familiar’s Trick",
+    displayNamePlural: "Familiar’s Tricks",
     type: () => Object({
         animal_types: Required({
             comment: `The animal types this trick is available to. Either it is available to all or only a list of specific animal types.
@@ -52,7 +54,7 @@ If no animal types are given, the animal disease applies to all animal types.`,
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/HairColor.js

@@ -11,7 +11,7 @@ export const HairColor = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",

package/lib/types/HomunculusType.js

@@ -11,5 +11,5 @@ export const HomunculusType = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
 });

package/lib/types/Lessons.js

@@ -19,7 +19,7 @@ export const Guideline = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",
@@ -59,7 +59,7 @@ export const Curriculum = Entity(import.meta.url, {
             }),
         })),
     }),
-    displayName: {},
+    instanceDisplayName: {},
     uniqueConstraints: [
         {
             entityMapKeyPath: "translations",
@@ -161,7 +161,7 @@ export const LessonPackage = Entity(import.meta.url, {
         })),
     }, { minProperties: 3 }),
     parentReferenceKey: "curriculum",
-    displayName: {},
+    instanceDisplayName: {},
 });
 const SpellworkChange = TypeAlias(import.meta.url, {
     name: "SpellworkChange",