optolith-database-schema 0.37.0 → 0.38.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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.38.0](https://github.com/elyukai/optolith-database-schema/compare/v0.37.0...v0.38.0) (2026-03-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* reconstruction and references can differ per edition
+
+### Features
+
+* display names for new skill applications and uses ([e3eaca0](https://github.com/elyukai/optolith-database-schema/commit/e3eaca0c25f6597bed456f6ae2edd0ff4afd2dae))
+* reconstruction and references can differ per edition ([8774da6](https://github.com/elyukai/optolith-database-schema/commit/8774da6c72786333b09235ee712d0864778dbbfe))
+
 ## [0.37.0](https://github.com/elyukai/optolith-database-schema/compare/v0.36.1...v0.37.0) (2026-03-14)
 
 

package/README.md

@@ -15,3 +15,20 @@ If you want to contribute to the database schema itself, please open an issue or
 ## Usage
 
 If you want to use the database (or parts of it) in your own project (most likely to support Optolith export formats in your own application), you can use the TypeScript sources as a simple database reader, at least if you have a project targeting JavaScript interpreters as well. This way, you already have proper typings. You can extract the database from the installation folder of Optolith and then configure the database reader to your needs.
+
+## Semantic Versioning
+
+The following situations are considered breaking changes:
+
+- Underlying data must be changed in order to comply with the new schema. Examples:
+  - Existing optional properties are made required
+  - New required properties are added
+  - Properties or enumeration cases are removed
+- Code that uses the data must be adjusted in order to use the new version. Examples:
+  - Existing required properties are made optional
+  - Enumeration cases are added
+  - Properties or enumeration cases are removed
+
+This implies that breaking changes can occur quite frequently, even if the changes are very small.
+
+A minor version bump can represent new optional properties, while patch version might represent adjustments in comments or display names for the editor.

package/gen/types.d.ts

@@ -20289,16 +20289,6 @@ export interface PlainBookRules {
 export interface BookRulesByEdition {
   editions: BookRulesOfEdition[]
 
-  /**
-   * Rules for reconstructing certain skills or abilities from the book.
-   */
-  reconstruction?: string
-
-  /**
-   * References to skills and abilities that, while mentioned in the book, cannot be learned from this book alone.
-   */
-  references?: string
-
   /**
    * Additional rules text that comes after all other rules.
    */
@@ -20315,6 +20305,16 @@ export interface BookRulesOfEdition {
    * The rules text.
    */
   text: string
+
+  /**
+   * Rules for reconstructing certain skills or abilities from the book.
+   */
+  reconstruction?: string
+
+  /**
+   * References to skills and abilities that, while mentioned in the book, cannot be learned from this book alone.
+   */
+  references?: string
 }
 
 export interface CeremonialItem {

package/lib/types/_ActivatableSkillApplicationsAndUses.js

@@ -36,6 +36,7 @@ export const NewSkillApplication = DB.Entity(import.meta.url, {
     }),
 });
 export const skill_applications = DB.Required({
+    displayName: "New Skill Applications",
     comment: "Registers new skill applications, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry.",
     type: DB.ChildEntities(NewSkillApplication),
 });
@@ -73,6 +74,7 @@ export const SkillUse = DB.Entity(import.meta.url, {
     }),
 });
 export const skill_uses = DB.Required({
+    displayName: "Skill Uses",
     comment: "Registers uses, which get enabled once this entry is activated. It specifies an entry-unique identifier and the skill it belongs to. A translation can be left out if its name equals the name of the origin activatable entry.",
     type: DB.ChildEntities(SkillUse),
 });

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

@@ -152,9 +152,9 @@ export declare const Book: DB.Entity<"Book", {
                 editions: DB.MemberDecl<DB.Array<DB.IncludeIdentifier<[], DB.TypeAlias<"BookRulesOfEdition", DB.Object<{
                     label: DB.MemberDecl<DB.String, true>;
                     text: DB.MemberDecl<DB.String, true>;
+                    reconstruction: DB.MemberDecl<DB.String, false>;
+                    references: DB.MemberDecl<DB.String, false>;
                 }>, []>>>, true>;
-                reconstruction: DB.MemberDecl<DB.String, false>;
-                references: DB.MemberDecl<DB.String, false>;
                 textAfter: DB.MemberDecl<DB.String, false>;
             }>, []>>>;
         }, []>>, false>;

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

@@ -242,14 +242,6 @@ const BookRulesByEdition = DB.TypeAlias(import.meta.url, {
         editions: DB.Required({
             type: DB.Array(DB.IncludeIdentifier(BookRulesOfEdition), { minItems: 1 }),
         }),
-        reconstruction: DB.Optional({
-            comment: "Rules for reconstructing certain skills or abilities from the book.",
-            type: DB.String({ minLength: 1, markdown: "block" }),
-        }),
-        references: DB.Optional({
-            comment: "References to skills and abilities that, while mentioned in the book, cannot be learned from this book alone.",
-            type: DB.String({ minLength: 1, markdown: "block" }),
-        }),
         textAfter: DB.Optional({
             comment: "Additional rules text that comes after all other rules.",
             type: DB.String({ minLength: 1, markdown: "block" }),
@@ -267,5 +259,13 @@ const BookRulesOfEdition = DB.TypeAlias(import.meta.url, {
             comment: "The rules text.",
             type: DB.String({ minLength: 1, markdown: "block" }),
         }),
+        reconstruction: DB.Optional({
+            comment: "Rules for reconstructing certain skills or abilities from the book.",
+            type: DB.String({ minLength: 1, markdown: "block" }),
+        }),
+        references: DB.Optional({
+            comment: "References to skills and abilities that, while mentioned in the book, cannot be learned from this book alone.",
+            type: DB.String({ minLength: 1, markdown: "block" }),
+        }),
     }),
 });

package/package.json

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