optolith-database-schema 0.19.1 → 0.20.0

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 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.20.0](https://github.com/elyukai/optolith-database-schema/compare/v0.19.1...v0.20.0) (2025-11-02)
+
+
+### ⚠ BREAKING CHANGES
+
+* align book type/category with official sources
+* use book cost variant with single single costs as well to enable label usage
+
+### Features
+
+* add book category ([b3a88fa](https://github.com/elyukai/optolith-database-schema/commit/b3a88fa9ea417930c4c5249869f4153404570393))
+
+
+### Bug Fixes
+
+* align book type/category with official sources ([b89bda8](https://github.com/elyukai/optolith-database-schema/commit/b89bda8e670d1a46d6a5ea2f094401e458ce62f7))
+* general select option display name customizer ([47b308b](https://github.com/elyukai/optolith-database-schema/commit/47b308b4b93deabb83aaec11b4036b9a70350a83))
+* make definite book cost variant translations optional if label is not used ([79c4daa](https://github.com/elyukai/optolith-database-schema/commit/79c4daa3d50aa3468f0c72ef6a5736779c421039))
+* use book cost variant with single single costs as well to enable label usage ([e3f9138](https://github.com/elyukai/optolith-database-schema/commit/e3f91381fe6d93525366e15c3d4073cda90821b8))
+
 ## [0.19.1](https://github.com/elyukai/optolith-database-schema/compare/v0.19.0...v0.19.1) (2025-10-27)
 
 

package/lib/types/_Activatable.js

@@ -119,7 +119,7 @@ export const GeneralSelectOption = Entity(import.meta.url, {
     parentReferenceKey: "parent",
     displayName: {},
     displayNameCustomizer: ({ instance, instanceDisplayName, instanceDisplayNameLocaleId, getDisplayNameForInstanceId, }) => ({
-        name: `${getDisplayNameForInstanceId(instance.parent[instance.parent.kind])} — ${instanceDisplayName}`,
+        name: `${getDisplayNameForInstanceId(instance.parent[instance.parent.kind])?.name} — ${instanceDisplayName}`,
         localeId: instanceDisplayNameLocaleId,
     }),
 });

package/lib/types/equipment/item/Book.d.ts

@@ -1,22 +1,48 @@
 import { Array, Entity, Enum, EnumCase, IncludeIdentifier, Object, String, TypeAlias } from "tsondb/schema/def";
 export declare const Book: Entity<"Book", {
+    types: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], Enum<"BookType", {
+        Mundane: EnumCase<IncludeIdentifier<[], Enum<"MundaneBookType", {
+            RomanceNovel: EnumCase<null>;
+            Poetry: EnumCase<null>;
+            PoliticalPamphlet: EnumCase<null>;
+            CrimeStory: EnumCase<null>;
+            FairyTale: EnumCase<null>;
+            Novel: EnumCase<null>;
+            ProfessionalPublication: EnumCase<import("tsondb/schema/def").ReferenceIdentifierType>;
+        }, []>>>;
+        Magical: EnumCase<null>;
+        Religious: EnumCase<null>;
+    }, []>>>, true>;
     cost: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], Enum<"BookCost", {
-        Single: EnumCase<IncludeIdentifier<[], Enum<"Cost", {
-            Free: EnumCase<null>;
-            Various: EnumCase<null>;
-            Invaluable: EnumCase<null>;
-            Fixed: EnumCase<IncludeIdentifier<[], TypeAlias<"FixedCost", Object<{
-                value: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").FloatType, true>;
-                translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"FixedCostTranslation", {
-                    wrap_in_text: import("tsondb/schema/def").MemberDecl<String, true>;
+        Single: EnumCase<IncludeIdentifier<[], Enum<"BookCostVariant", {
+            Definite: EnumCase<IncludeIdentifier<[], TypeAlias<"DefiniteBookCostVariant", Object<{
+                cost: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], Enum<"Cost", {
+                    Free: EnumCase<null>;
+                    Various: EnumCase<null>;
+                    Invaluable: EnumCase<null>;
+                    Fixed: EnumCase<IncludeIdentifier<[], TypeAlias<"FixedCost", Object<{
+                        value: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").FloatType, true>;
+                        translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"FixedCostTranslation", {
+                            wrap_in_text: import("tsondb/schema/def").MemberDecl<String, true>;
+                        }>, false>;
+                    }>, []>>>;
+                    Range: EnumCase<IncludeIdentifier<[], TypeAlias<"CostRange", Object<{
+                        from: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").FloatType, true>;
+                        to: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").FloatType, true>;
+                        translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"CostRangeTranslation", {
+                            wrap_in_text: import("tsondb/schema/def").MemberDecl<String, true>;
+                        }>, false>;
+                    }>, []>>>;
+                }, []>>, true>;
+                translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"DefiniteBookCostVariantTranslation", {
+                    label: import("tsondb/schema/def").MemberDecl<String, false>;
                 }>, false>;
             }>, []>>>;
-            Range: EnumCase<IncludeIdentifier<[], TypeAlias<"CostRange", Object<{
-                from: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").FloatType, true>;
-                to: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").FloatType, true>;
-                translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"CostRangeTranslation", {
-                    wrap_in_text: import("tsondb/schema/def").MemberDecl<String, true>;
-                }>, false>;
+            Indefinite: EnumCase<IncludeIdentifier<[], TypeAlias<"IndefiniteBookCostVariant", Object<{
+                translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"IndefiniteBookCostVariantTranslation", {
+                    label: import("tsondb/schema/def").MemberDecl<String, false>;
+                    description: import("tsondb/schema/def").MemberDecl<String, true>;
+                }>, true>;
             }>, []>>>;
         }, []>>>;
         Multiple: EnumCase<Array<IncludeIdentifier<[], Enum<"BookCostVariant", {
@@ -41,7 +67,7 @@ export declare const Book: Entity<"Book", {
                 }, []>>, true>;
                 translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"DefiniteBookCostVariantTranslation", {
                     label: import("tsondb/schema/def").MemberDecl<String, false>;
-                }>, true>;
+                }>, false>;
             }>, []>>>;
             Indefinite: EnumCase<IncludeIdentifier<[], TypeAlias<"IndefiniteBookCostVariant", Object<{
                 translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"IndefiniteBookCostVariantTranslation", {

package/lib/types/equipment/item/Book.js

@@ -1,4 +1,5 @@
 import { Array, Entity, Enum, EnumCase, IncludeIdentifier, Object, Optional, Required, String, TypeAlias, } from "tsondb/schema/def";
+import { SkillIdentifier } from "../../_Identifier.js";
 import { NestedTranslationMap } from "../../Locale.js";
 import { Errata } from "../../source/_Erratum.js";
 import { src } from "../../source/_PublicationRef.js";
@@ -7,6 +8,10 @@ export const Book = Entity(import.meta.url, {
     name: "Book",
     namePlural: "Books",
     type: () => Object({
+        types: Required({
+            comment: "The type of book.",
+            type: Array(IncludeIdentifier(BookType), { minItems: 1, uniqueItems: true }),
+        }),
         cost: Required({
             comment: "The cost in silverthalers.",
             type: IncludeIdentifier(BookCost),
@@ -56,13 +61,65 @@ export const Book = Entity(import.meta.url, {
     }),
     displayName: {},
 });
+const BookType = Enum(import.meta.url, {
+    name: "BookType",
+    comment: "The type of book.",
+    values: () => ({
+        Mundane: EnumCase({
+            comment: "A mundane book without special rules.",
+            type: IncludeIdentifier(MundaneBookType),
+        }),
+        Magical: EnumCase({
+            comment: "A magical book.",
+            type: null,
+        }),
+        Religious: EnumCase({
+            comment: "A religious book.",
+            type: null,
+        }),
+    }),
+});
+const MundaneBookType = Enum(import.meta.url, {
+    name: "MundaneBookType",
+    comment: "The type of mundane book, i.e. the type of writing it contains.",
+    values: () => ({
+        RomanceNovel: EnumCase({
+            comment: "A romance novel.",
+            type: null,
+        }),
+        Poetry: EnumCase({
+            comment: "A piece of poetry.",
+            type: null,
+        }),
+        PoliticalPamphlet: EnumCase({
+            comment: "A political pamphlet.",
+            type: null,
+        }),
+        CrimeStory: EnumCase({
+            comment: "A crime story.",
+            type: null,
+        }),
+        FairyTale: EnumCase({
+            comment: "A fairy tale.",
+            type: null,
+        }),
+        Novel: EnumCase({
+            comment: "A novel.",
+            type: null,
+        }),
+        ProfessionalPublication: EnumCase({
+            comment: "A professional publication about a specific topic, represented by a (knowledge) skill.",
+            type: SkillIdentifier(),
+        }),
+    }),
+});
 const BookCost = Enum(import.meta.url, {
     name: "BookCost",
     comment: "The cost of the book, which may be a single value or multiple values that are defined by specific editions or other defining factors of the book.",
     values: () => ({
         Single: EnumCase({
             comment: "The book only has a single cost description.",
-            type: IncludeIdentifier(Cost),
+            type: IncludeIdentifier(BookCostVariant),
         }),
         Multiple: EnumCase({
             comment: "The book’s cost varies by edition or other factors.",
@@ -92,12 +149,12 @@ const DefiniteBookCostVariant = TypeAlias(import.meta.url, {
             comment: "The cost in silverthalers.",
             type: IncludeIdentifier(Cost),
         }),
-        translations: NestedTranslationMap(Required, "DefiniteBookCostVariant", Object({
+        translations: NestedTranslationMap(Optional, "DefiniteBookCostVariant", Object({
             label: Optional({
                 comment: "The label for the cost variant, e.g. “Original script”.",
                 type: String({ minLength: 1, isMarkdown: true }),
             }),
-        })),
+        }, { minProperties: 1 })),
     }),
 });
 const IndefiniteBookCostVariant = TypeAlias(import.meta.url, {
@@ -110,7 +167,7 @@ const IndefiniteBookCostVariant = TypeAlias(import.meta.url, {
                 type: String({ minLength: 1, isMarkdown: true }),
             }),
             description: Required({
-                comment: "The description of the cost variant, e.g. “Original script”.",
+                comment: "The description of the cost variant, e.g. “less”.",
                 type: String({ minLength: 1, isMarkdown: true }),
             }),
         })),

package/package.json

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