optolith-database-schema 0.18.8 → 0.18.9

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.18.9](https://github.com/elyukai/optolith-database-schema/compare/v0.18.8...v0.18.9) (2025-10-15)
+
+
+### Features
+
+* add alternative rule and player type entities ([034a2ed](https://github.com/elyukai/optolith-database-schema/commit/034a2ed6849a5581951fe1757c5c7179509f76bd))
+
 ## [0.18.8](https://github.com/elyukai/optolith-database-schema/compare/v0.18.7...v0.18.8) (2025-10-14)
 
 ## [0.18.7](https://github.com/elyukai/optolith-database-schema/compare/v0.18.6...v0.18.7) (2025-10-14)

package/lib/main.js

@@ -76,7 +76,7 @@ import { Weapon } from "./types/equipment/item/Weapon.js";
 import { WeaponAccessory } from "./types/equipment/item/WeaponAccessory.js";
 import { ArmorType } from "./types/equipment/item/sub/ArmorType.js";
 import { Reach } from "./types/equipment/item/sub/Reach.js";
-import { ClothingPackage, Laboratory } from "./types/index.js";
+import { AlternativeRule, ClothingPackage, Laboratory, PlayerType } from "./types/index.js";
 import { AnimistPower } from "./types/magicalActions/AnimistPower.js";
 import { Tribe } from "./types/magicalActions/AnimistPower_Tribe.js";
 import { Curse } from "./types/magicalActions/Curse.js";
@@ -154,6 +154,7 @@ export const schema = Schema([
     AdvancedMagicalSpecialAbility,
     AdvancedSkillSpecialAbility,
     Advantage,
+    AlternativeRule,
     Ammunition,
     AncestorGlyph,
     AnimalCare,
@@ -255,6 +256,7 @@ export const schema = Schema([
     PatronCategory,
     Patron,
     PersonalityTrait,
+    PlayerType,
     Poison,
     Profession,
     Property,

package/lib/types/_Identifier.d.ts

@@ -4,6 +4,7 @@ export declare const AdvancedKarmaSpecialAbilityIdentifier: () => R;
 export declare const AdvancedMagicalSpecialAbilityIdentifier: () => R;
 export declare const AdvancedSkillSpecialAbilityIdentifier: () => R;
 export declare const AdvantageIdentifier: () => R;
+export declare const AlternativeRuleIdentifier: () => R;
 export declare const AmmunitionIdentifier: () => R;
 export declare const AncestorGlyphIdentifier: () => R;
 export declare const AnimalCareIdentifier: () => R;
@@ -107,6 +108,7 @@ export declare const PactTypeIdentifier: () => R;
 export declare const PatronCategoryIdentifier: () => R;
 export declare const PatronIdentifier: () => R;
 export declare const PersonalityTraitIdentifier: () => R;
+export declare const PlayerTypeIdentifier: () => R;
 export declare const PoisonIdentifier: () => R;
 export declare const ProfessionIdentifier: () => R;
 export declare const ProfessionPackageIdentifier: () => R;

package/lib/types/_Identifier.js

@@ -75,6 +75,8 @@ import { Profession, ProfessionPackage, ProfessionVariant, ProfessionVersion, }
 import { Property } from "./Property.js";
 import { Race, RaceVariant } from "./Race.js";
 import { Ritual } from "./Ritual.js";
+import { AlternativeRule } from "./rule/AlternativeRule.js";
+import { PlayerType } from "./rule/AlternativeRule_PlayerType.js";
 import { CoreRule } from "./rule/CoreRule.js";
 import { FocusRule } from "./rule/FocusRule.js";
 import { Subject } from "./rule/FocusRule_Subject.js";
@@ -148,6 +150,7 @@ export const AdvancedKarmaSpecialAbilityIdentifier = () => R(AdvancedKarmaSpecia
 export const AdvancedMagicalSpecialAbilityIdentifier = () => R(AdvancedMagicalSpecialAbility);
 export const AdvancedSkillSpecialAbilityIdentifier = () => R(AdvancedSkillSpecialAbility);
 export const AdvantageIdentifier = () => R(Advantage);
+export const AlternativeRuleIdentifier = () => R(AlternativeRule);
 export const AmmunitionIdentifier = () => R(Ammunition);
 export const AncestorGlyphIdentifier = () => R(AncestorGlyph);
 export const AnimalCareIdentifier = () => R(AnimalCare);
@@ -251,6 +254,7 @@ export const PactTypeIdentifier = () => R(PactType);
 export const PatronCategoryIdentifier = () => R(PatronCategory);
 export const PatronIdentifier = () => R(Patron);
 export const PersonalityTraitIdentifier = () => R(PersonalityTrait);
+export const PlayerTypeIdentifier = () => R(PlayerType);
 export const PoisonIdentifier = () => R(Poison);
 export const ProfessionIdentifier = () => R(Profession);
 export const ProfessionPackageIdentifier = () => R(ProfessionPackage);

package/lib/types/index.d.ts

@@ -78,6 +78,8 @@ export { Property } from "./Property.js";
 export { Race } from "./Race.js";
 export { Region } from "./Region.js";
 export { Ritual } from "./Ritual.js";
+export { AlternativeRule } from "./rule/AlternativeRule.js";
+export { PlayerType } from "./rule/AlternativeRule_PlayerType.js";
 export { CoreRule } from "./rule/CoreRule.js";
 export { FocusRule } from "./rule/FocusRule.js";
 export { Subject } from "./rule/FocusRule_Subject.js";

package/lib/types/index.js

@@ -78,6 +78,8 @@ export { Property } from "./Property.js";
 export { Race } from "./Race.js";
 export { Region } from "./Region.js";
 export { Ritual } from "./Ritual.js";
+export { AlternativeRule } from "./rule/AlternativeRule.js";
+export { PlayerType } from "./rule/AlternativeRule_PlayerType.js";
 export { CoreRule } from "./rule/CoreRule.js";
 export { FocusRule } from "./rule/FocusRule.js";
 export { Subject } from "./rule/FocusRule_Subject.js";

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

@@ -0,0 +1,53 @@
+import { Array, Boolean, Entity, IncludeIdentifier, Object, String } from "tsondb/schema/def";
+export declare const AlternativeRule: Entity<"AlternativeRule", {
+    playerTypes: import("tsondb/schema/def").MemberDecl<Array<import("tsondb/schema/def").ReferenceIdentifierType>, true>;
+    isMissingImplementation: import("tsondb/schema/def").MemberDecl<Boolean, true>;
+    src: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"PublicationRefs", Array<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, {
+            initial: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"InitialOccurrence", Object<{
+                printing: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").IntegerType, false>;
+                pages: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"PageRange", Object<{
+                    first_page: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Page", {
+                        InsideCoverFront: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        InsideCoverBack: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        Numbered: import("tsondb/schema/def").EnumCaseDecl<import("tsondb/schema/def").IntegerType>;
+                    }, []>>, true>;
+                    last_page: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Page", {
+                        InsideCoverFront: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        InsideCoverBack: import("tsondb/schema/def").EnumCaseDecl<null>;
+                        Numbered: import("tsondb/schema/def").EnumCaseDecl<import("tsondb/schema/def").IntegerType>;
+                    }, []>>, false>;
+                }>, []>>>, true>;
+            }>, []>>, true>;
+            revisions: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Revision", {
+                Since: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"Since", Object<{
+                    printing: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").IntegerType, true>;
+                    pages: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"PageRange", Object<{
+                        first_page: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Page", {
+                            InsideCoverFront: import("tsondb/schema/def").EnumCaseDecl<null>;
+                            InsideCoverBack: import("tsondb/schema/def").EnumCaseDecl<null>;
+                            Numbered: import("tsondb/schema/def").EnumCaseDecl<import("tsondb/schema/def").IntegerType>;
+                        }, []>>, true>;
+                        last_page: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").EnumDecl<"Page", {
+                            InsideCoverFront: import("tsondb/schema/def").EnumCaseDecl<null>;
+                            InsideCoverBack: import("tsondb/schema/def").EnumCaseDecl<null>;
+                            Numbered: import("tsondb/schema/def").EnumCaseDecl<import("tsondb/schema/def").IntegerType>;
+                        }, []>>, false>;
+                    }>, []>>>, true>;
+                }>, []>>>;
+                Deprecated: import("tsondb/schema/def").EnumCaseDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"Deprecation", Object<{
+                    printing: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").IntegerType, true>;
+                }>, []>>>;
+            }, []>>>, false>;
+        }>, true>;
+    }>, []>>>, []>>, true>;
+    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"AlternativeRuleTranslation", {
+        name: import("tsondb/schema/def").MemberDecl<String, true>;
+        description: import("tsondb/schema/def").MemberDecl<String, true>;
+        errata: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"Errata", Array<IncludeIdentifier<[], import("tsondb/schema/def").TypeAliasDecl<"Erratum", Object<{
+            date: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").DateType, true>;
+            description: import("tsondb/schema/def").MemberDecl<String, true>;
+        }>, []>>>, []>>, false>;
+    }>, true>;
+}, undefined>;

package/lib/types/rule/AlternativeRule.js

@@ -0,0 +1,34 @@
+import { Array, Boolean, Entity, IncludeIdentifier, Object, Optional, Required, String, } from "tsondb/schema/def";
+import { PlayerTypeIdentifier } from "../_Identifier.js";
+import { NestedTranslationMap } from "../Locale.js";
+import { Errata } from "../source/_Erratum.js";
+import { src } from "../source/_PublicationRef.js";
+export const AlternativeRule = Entity(import.meta.url, {
+    name: "AlternativeRule",
+    namePlural: "AlternativeRules",
+    type: () => Object({
+        playerTypes: Required({
+            comment: "The player types this alternative rule is suitable for.",
+            type: Array(PlayerTypeIdentifier(), { minItems: 1, uniqueItems: true }),
+        }),
+        isMissingImplementation: Required({
+            comment: "Has the alternative rule not been implemented in Optolith yet? This is also true if the alternative rule does not (currently) apply to any Optolith feature.",
+            type: Boolean(),
+        }),
+        src,
+        translations: NestedTranslationMap(Required, "AlternativeRule", Object({
+            name: Required({
+                comment: "The alternative rule’s name.",
+                type: String({ minLength: 1 }),
+            }),
+            description: Required({
+                comment: "The description of the alternative rule.",
+                type: String({ minLength: 1, isMarkdown: true }),
+            }),
+            errata: Optional({
+                type: IncludeIdentifier(Errata),
+            }),
+        })),
+    }),
+    displayName: {},
+});

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

@@ -0,0 +1,6 @@
+import { Entity, String } from "tsondb/schema/def";
+export declare const PlayerType: Entity<"PlayerType", {
+    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"PlayerTypeTranslation", {
+        name: import("tsondb/schema/def").MemberDecl<String, true>;
+    }>, true>;
+}, undefined>;

package/lib/types/rule/AlternativeRule_PlayerType.js

@@ -0,0 +1,16 @@
+import { Entity, Object, Required, String } from "tsondb/schema/def";
+import { NestedTranslationMap } from "../Locale.js";
+export const PlayerType = Entity(import.meta.url, {
+    name: "PlayerType",
+    namePlural: "PlayerTypes",
+    comment: "Player types describe different playing styles, expectations and wishes of players.",
+    type: () => Object({
+        translations: NestedTranslationMap(Required, "PlayerType", Object({
+            name: Required({
+                comment: "The player type.",
+                type: String({ minLength: 1 }),
+            }),
+        })),
+    }),
+    displayName: {},
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.18.8",
+  "version": "0.18.9",
   "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",