optolith-database-schema 0.24.2 → 0.25.0

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 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.25.0](https://github.com/elyukai/optolith-database-schema/compare/v0.24.3...v0.25.0) (2025-12-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* add unique constraints
+
+### Features
+
+* add unique constraints ([8bacb48](https://github.com/elyukai/optolith-database-schema/commit/8bacb489d804d280801b38111d96732fb9a317fc))
+* adjust display names of pact domains and types ([6086a6d](https://github.com/elyukai/optolith-database-schema/commit/6086a6d89160f7f09f9f6474cc240acd4d518f43))
+
+## [0.24.3](https://github.com/elyukai/optolith-database-schema/compare/v0.24.2...v0.24.3) (2025-12-09)
+
+
+### Features
+
+* add raw value option to elixirs ([f14ecf0](https://github.com/elyukai/optolith-database-schema/commit/f14ecf01b4eb6acbaee8b27abb95e9907a41aed4)), closes [#84](https://github.com/elyukai/optolith-database-schema/issues/84)
+
+
+### Bug Fixes
+
+* profession variants could not be entered ([df21ff3](https://github.com/elyukai/optolith-database-schema/commit/df21ff3e992c9976a5111de1a46f644f26f8c122))
+
 ## [0.24.2](https://github.com/elyukai/optolith-database-schema/compare/v0.24.1...v0.24.2) (2025-12-09)
 
 

package/gen/types.d.ts

@@ -176,6 +176,23 @@ export type EntityMap = {
   ZibiljaRitual: ZibiljaRitual
 }
 
+export type ChildEntityMap = {
+  Enhancement: [Enhancement, "parent", Enhancement["parent"]]
+  GeneralSelectOption: [GeneralSelectOption, "parent", GeneralSelectOption["parent"]]
+  LanguageSpecialization: [LanguageSpecialization, "parent", LanguageSpecialization["parent"]]
+  LessonPackage: [LessonPackage, "curriculum", LessonPackage["curriculum"]]
+  MagicalRuneOption: [MagicalRuneOption, "parent", MagicalRuneOption["parent"]]
+  NewSkillApplication: [NewSkillApplication, "parent", NewSkillApplication["parent"]]
+  PactDomain: [PactDomain, "parent", PactDomain["parent"]]
+  PactType: [PactType, "parent", PactType["parent"]]
+  ProfessionPackage: [ProfessionPackage, "profession_version", ProfessionPackage["profession_version"]]
+  ProfessionVariant: [ProfessionVariant, "profession_package", ProfessionVariant["profession_package"]]
+  ProfessionVersion: [ProfessionVersion, "profession", ProfessionVersion["profession"]]
+  RaceVariant: [RaceVariant, "race", RaceVariant["race"]]
+  SkillApplication: [SkillApplication, "parent", SkillApplication["parent"]]
+  SkillUse: [SkillUse, "parent", SkillUse["parent"]]
+}
+
 export type StringableTranslationParameter = {
   toString(): string
 }
@@ -7677,7 +7694,7 @@ export interface ProfessionPackage {
   /**
    * Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required.
    */
-  variants?: ProfessionVariant_ID[]
+  variants: ProfessionVariant_ID[]
 }
 
 /**
@@ -19895,6 +19912,11 @@ export interface Elixir {
    */
   effect_types?: EffectType[]
 
+  /**
+   * The raw (ingredients) value per level, in silverthalers.
+   */
+  value?: number
+
   /**
    * The cost per ingredient level in silverthalers.
    */

package/lib/test.d.ts

@@ -1 +1 @@
-import "./main.js";
+export {};

package/lib/test.js

@@ -1,2 +1,11 @@
+import { stderr } from "node:process";
+import { styleText } from "node:util";
 // importing the main file will run the schema checks
-import "./main.js";
+import("./main.js")
+    .then(() => {
+    console.log(styleText("green", "Schema is valid"));
+})
+    .catch((err) => {
+    console.error(styleText("red", err instanceof Error ? err.message : String(err), { stream: stderr }));
+    process.exitCode = 1;
+});

package/lib/types/Advantage.js

@@ -46,4 +46,11 @@ export const Advantage = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name_in_library",
+            keyPathInEntityMapFallback: "name",
+        },
+    ],
 });

package/lib/types/AnimalDisease.js

@@ -26,4 +26,10 @@ If no causes are given, the disease is not communicable to intelligent creatures
         translations: NestedTranslationMap(Required, "AnimalDisease", DiseaseTranslation),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/AnimalType.js

@@ -12,4 +12,10 @@ export const AnimalType = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/ArcaneBardTradition.js

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

package/lib/types/ArcaneDancerTradition.js

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

package/lib/types/Aspect.js

@@ -18,4 +18,10 @@ export const Aspect = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/Attribute.js

@@ -21,4 +21,14 @@ export const Attribute = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "abbreviation",
+        },
+    ],
 });

package/lib/types/Blessing.js

@@ -45,6 +45,12 @@ export const Blessing = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const BlessingPerformanceParameters = TypeAlias(import.meta.url, {
     name: "BlessingPerformanceParameters",

package/lib/types/Cantrip.js

@@ -56,6 +56,12 @@ export const Cantrip = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const CantripNote = Enum(import.meta.url, {
     name: "CantripNote",

package/lib/types/Ceremony.js

@@ -85,4 +85,10 @@ export const Ceremony = Entity(import.meta.url, {
         }),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/CombatTechnique.js

@@ -40,6 +40,12 @@ export const CloseCombatTechnique = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const CloseCombatTechniqueSpecialRules = TypeAlias(import.meta.url, {
     name: "CloseCombatTechniqueSpecialRules",
@@ -91,6 +97,12 @@ export const RangedCombatTechnique = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const RangedCombatTechniqueSpecialRules = TypeAlias(import.meta.url, {
     name: "RangedCombatTechniqueSpecialRules",

package/lib/types/Condition.js

@@ -29,4 +29,10 @@ export const Condition = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/Continent.js

@@ -13,4 +13,10 @@ export const Continent = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/Culture.js

@@ -94,6 +94,12 @@ export const Culture = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const AreaKnowledge = TypeAlias(import.meta.url, {
     name: "AreaKnowledge",

package/lib/types/DerivedCharacteristic.js

@@ -26,6 +26,16 @@ export const DerivedCharacteristic = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "abbreviation",
+        },
+    ],
 });
 const CalculationTranslation = TypeAlias(import.meta.url, {
     name: "CalculationTranslation",

package/lib/types/Disadvantage.js

@@ -47,4 +47,11 @@ export const Disadvantage = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name_in_library",
+            keyPathInEntityMapFallback: "name",
+        },
+    ],
 });

package/lib/types/Disease.js

@@ -18,4 +18,10 @@ export const Disease = Entity(import.meta.url, {
         translations: NestedTranslationMap(Required, "Disease", DiseaseTranslation),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/Element.js

@@ -12,4 +12,10 @@ export const Element = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/ExperienceLevel.js

@@ -41,4 +41,10 @@ export const ExperienceLevel = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/EyeColor.js

@@ -12,4 +12,10 @@ export const EyeColor = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/FamiliarsTrick.js

@@ -53,6 +53,12 @@ If no animal types are given, the animal disease applies to all animal types.`,
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const FamiliarsTrickProperty = Enum(import.meta.url, {
     name: "FamiliarsTrickProperty",

package/lib/types/HairColor.js

@@ -12,4 +12,10 @@ export const HairColor = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/Lessons.js

@@ -20,6 +20,12 @@ export const Guideline = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 export const Curriculum = Entity(import.meta.url, {
     name: "Curriculum",
@@ -54,6 +60,12 @@ export const Curriculum = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const ElectiveSpellworks = Enum(import.meta.url, {
     name: "ElectiveSpellworks",

package/lib/types/LiturgicalChant.js

@@ -85,4 +85,10 @@ export const LiturgicalChant = Entity(import.meta.url, {
         }),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/Locale.js

@@ -1289,6 +1289,16 @@ export const Locale = Entity(import.meta.url, {
             }, { allKeysAreRequired: true }),
         }),
     }),
+    uniqueConstraints: [
+        [
+            {
+                keyPath: "name",
+            },
+            {
+                keyPath: "region",
+            },
+        ],
+    ],
 });
 export const NestedTranslationMap = (MemberDeclCreator, entityName, type) => MemberDeclCreator({
     comment: "All translations for the entry, identified by IETF language tag (BCP47).",

package/lib/types/MetaCondition.js

@@ -30,4 +30,10 @@ export const MetaCondition = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/PactCategory.js

@@ -27,6 +27,12 @@ export const PactCategory = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 export const PactType = Entity(import.meta.url, {
     name: "PactType",
@@ -45,6 +51,21 @@ export const PactType = Entity(import.meta.url, {
     }),
     parentReferenceKey: "parent",
     displayName: {},
+    displayNameCustomizer: ({ instance, instanceDisplayName, instanceDisplayNameLocaleId, getDisplayNameForInstanceId, }) => ({
+        name: `${getDisplayNameForInstanceId(instance.parent)?.name ?? ""} — ${instanceDisplayName}`,
+        localeId: instanceDisplayNameLocaleId,
+    }),
+    uniqueConstraints: [
+        [
+            {
+                keyPath: "parent",
+            },
+            {
+                entityMapKeyPath: "translations",
+                keyPathInEntityMap: "name",
+            },
+        ],
+    ],
 });
 export const PactDomain = Entity(import.meta.url, {
     name: "PactDomain",
@@ -63,4 +84,19 @@ export const PactDomain = Entity(import.meta.url, {
     }),
     parentReferenceKey: "parent",
     displayName: {},
+    displayNameCustomizer: ({ instance, instanceDisplayName, instanceDisplayNameLocaleId, getDisplayNameForInstanceId, }) => ({
+        name: `${getDisplayNameForInstanceId(instance.parent)?.name ?? ""} — ${instanceDisplayName}`,
+        localeId: instanceDisplayNameLocaleId,
+    }),
+    uniqueConstraints: [
+        [
+            {
+                keyPath: "parent",
+            },
+            {
+                entityMapKeyPath: "translations",
+                keyPathInEntityMap: "name",
+            },
+        ],
+    ],
 });

package/lib/types/Patron.js

@@ -59,6 +59,12 @@ export const Patron = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const PatronCulture = TypeAlias(import.meta.url, {
     name: "PatronCulture",

package/lib/types/PatronCategory.js

@@ -17,4 +17,10 @@ export const PatronCategory = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/PersonalityTrait.js

@@ -36,6 +36,12 @@ export const PersonalityTrait = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const PersonalityTraitEffect = TypeAlias(import.meta.url, {
     name: "PersonalityTraitEffect",

package/lib/types/Profession.d.ts

@@ -546,7 +546,7 @@ export declare const Profession: Entity<"Profession", {
                     full_text: import("tsondb/schema/def").MemberDecl<String, false>;
                     concluding_text: import("tsondb/schema/def").MemberDecl<String, false>;
                 }>, true>;
-            }, "profession_package">>, false>;
+            }, "profession_package">>, true>;
         }, "profession_version">>, true>;
         suggested_advantages: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"CommonnessRatedAdvantageDisadvantage", ObjectType<{
             id: import("tsondb/schema/def").MemberDecl<TypeArgument<import("tsondb/schema/def").TypeParameter<"Identifier", import("tsondb/schema/def").Type>>, true>;
@@ -1162,7 +1162,7 @@ export declare const ProfessionVersion: Entity<"ProfessionVersion", {
                 full_text: import("tsondb/schema/def").MemberDecl<String, false>;
                 concluding_text: import("tsondb/schema/def").MemberDecl<String, false>;
             }>, true>;
-        }, "profession_package">>, false>;
+        }, "profession_package">>, true>;
     }, "profession_version">>, true>;
     suggested_advantages: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<import("tsondb/schema/def").TypeParameter<string, import("tsondb/schema/def").Type>[], TypeAlias<"CommonnessRatedAdvantageDisadvantage", ObjectType<{
         id: import("tsondb/schema/def").MemberDecl<TypeArgument<import("tsondb/schema/def").TypeParameter<"Identifier", import("tsondb/schema/def").Type>>, true>;
@@ -1770,7 +1770,7 @@ export declare const ProfessionPackage: Entity<"ProfessionPackage", {
             full_text: import("tsondb/schema/def").MemberDecl<String, false>;
             concluding_text: import("tsondb/schema/def").MemberDecl<String, false>;
         }>, true>;
-    }, "profession_package">>, false>;
+    }, "profession_package">>, true>;
 }, "profession_version">;
 export declare const ProfessionVariant: Entity<"ProfessionVariant", {
     profession_package: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;

package/lib/types/Profession.js

@@ -193,7 +193,7 @@ export const ProfessionPackage = Entity(import.meta.url, {
             comment: "If the selection of a profession variant is required.",
             type: Boolean(),
         }),
-        variants: Optional({
+        variants: Required({
             comment: "Provides examples of variants for the profession, which may include changes to AP values and additional or modified skill ratings, special abilities, or combat techniques, as compared to the basic profession. Usually picking a variant is optional, but there are some rare exceptions where picking a variant is required.",
             type: ChildEntities(ProfessionVariant),
         }),

package/lib/types/Property.js

@@ -17,4 +17,10 @@ export const Property = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/Race.js

@@ -89,6 +89,12 @@ export const Race = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });
 const BaseValues = TypeAlias(import.meta.url, {
     name: "BaseValues",
@@ -273,6 +279,17 @@ export const RaceVariant = Entity(import.meta.url, {
     }),
     parentReferenceKey: "race",
     displayName: {},
+    uniqueConstraints: [
+        [
+            {
+                keyPath: "race",
+            },
+            {
+                entityMapKeyPath: "translations",
+                keyPathInEntityMap: "name",
+            },
+        ],
+    ],
 });
 const RandomHeightGeneration = TypeAlias(import.meta.url, {
     name: "RandomHeightGeneration",

package/lib/types/Region.js

@@ -12,4 +12,10 @@ export const Region = Entity(import.meta.url, {
         })),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });

package/lib/types/Ritual.js

@@ -86,4 +86,10 @@ export const Ritual = Entity(import.meta.url, {
         }),
     }),
     displayName: {},
+    uniqueConstraints: [
+        {
+            entityMapKeyPath: "translations",
+            keyPathInEntityMap: "name",
+        },
+    ],
 });