@optolith/entity-descriptions 0.2.0 → 0.3.1

package/CHANGELOG.md

@@ -2,6 +2,71 @@
 
 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.3.1](https://github.com/Optolith/entity-descriptions/compare/v0.3.0...v0.3.1) (2026-02-25)
+
+## [0.3.0](https://github.com/Optolith/entity-descriptions/compare/v0.2.1...v0.3.0) (2026-02-25)
+
+
+### ⚠ BREAKING CHANGES
+
+* stricter types for body sections
+* migrate codebase to TSONDB database
+
+* migrate codebase to TSONDB database ([e702883](https://github.com/Optolith/entity-descriptions/commit/e70288335ec8e837b1624ba7e9749921cc6dfad1))
+
+
+### Features
+
+* add attribute description generators ([02f332e](https://github.com/Optolith/entity-descriptions/commit/02f332eea66a2d24dd8308e98ef41650909d305d))
+* add derived characteristic description generator and main entrypoint ([5d47824](https://github.com/Optolith/entity-descriptions/commit/5d47824b4b4b95aaff5e6fd7c486dc7f87b8c555))
+* add description generator for alternative rules ([6b2d0a9](https://github.com/Optolith/entity-descriptions/commit/6b2d0a9647725903e6e80c21c13f98c2a26675f7))
+* add description generator for curricula ([7a9f8be](https://github.com/Optolith/entity-descriptions/commit/7a9f8be30c0d5425a923f780a0c0ff27a983ea27))
+* add description generator for curses ([c686fe7](https://github.com/Optolith/entity-descriptions/commit/c686fe7d4c2e82d25b07249ff86498c958622b5e))
+* add description generators for (dis)advantages, special abilities and tradition artifact enchantments ([f8664b9](https://github.com/Optolith/entity-descriptions/commit/f8664b9194a7f6855a865308d75f508aea6f8b32))
+* add labeled sections and definition list styles ([92d175d](https://github.com/Optolith/entity-descriptions/commit/92d175dcac0c93245c11df6cec3a7a2d8f876c19))
+* animist power description generator ([a048505](https://github.com/Optolith/entity-descriptions/commit/a0485059dad65b1e0fbbf0a65305f3b3b2897993))
+* collect errata ([e0df04f](https://github.com/Optolith/entity-descriptions/commit/e0df04fdd7887660399d89747dbd8e98148ef14a))
+* culture description generator ([d1fa45e](https://github.com/Optolith/entity-descriptions/commit/d1fa45ef4c289e5aee62ac9ee43277200f771386))
+* disease description generator ([070afac](https://github.com/Optolith/entity-descriptions/commit/070afac3f32b7c13662060181204db6530d37c18))
+* domination ritual description generator ([76f55c8](https://github.com/Optolith/entity-descriptions/commit/76f55c8019d8ce86b20966cc4f1d113e6383fe80))
+* elixir description generator ([364b053](https://github.com/Optolith/entity-descriptions/commit/364b053c1d54f8c3311c0c5f9d4a1f346fa3b441))
+* elven magical song description generator ([0bf136a](https://github.com/Optolith/entity-descriptions/commit/0bf136a171ebb046393d98312d8173ba82871d71))
+* equipment description generators ([9847d2b](https://github.com/Optolith/entity-descriptions/commit/9847d2b1586206de10eb70d059e28fb3648d1fd7))
+* familiar’s trick description generator ([931ba54](https://github.com/Optolith/entity-descriptions/commit/931ba5478ef009ee426e1794beb264a1f9aca194))
+* geode ritual description generator ([2c4af0e](https://github.com/Optolith/entity-descriptions/commit/2c4af0eae6b6add22733b8583ae460a312662813))
+* influence description generator ([5f253d3](https://github.com/Optolith/entity-descriptions/commit/5f253d3b9a24f4d2a347dfd679092545759c5169))
+* jester trick description generator ([7170289](https://github.com/Optolith/entity-descriptions/commit/7170289dea3de8f1fd97240b58eafb6c21942882))
+* magical dance and magical melody description generators ([e11f06b](https://github.com/Optolith/entity-descriptions/commit/e11f06b6cd62d14706f073653b953875a1a794f9))
+* magical rune description generator ([7121a31](https://github.com/Optolith/entity-descriptions/commit/7121a31324450ba7a0442a2317527246384b3781))
+* personality trait description generator ([11d856d](https://github.com/Optolith/entity-descriptions/commit/11d856d19ef9fa50cfa4218b0a853fbd3e0ec342))
+* poison description generator ([1979cab](https://github.com/Optolith/entity-descriptions/commit/1979cabff94e219ae76d782e4d1e1c3d77b1a8f2))
+* print prerequisites ([235f6eb](https://github.com/Optolith/entity-descriptions/commit/235f6eb08d9c6513d325e0bd4f8f7c88a29a6559))
+* profession description generator ([cf9be74](https://github.com/Optolith/entity-descriptions/commit/cf9be74548bf0a98d682815d3389aba814b707ef))
+* race description generator ([7a0d7ed](https://github.com/Optolith/entity-descriptions/commit/7a0d7edc69952fafa3728fec2bd7187fc6d8d856))
+* sex practice description generator ([3d8d229](https://github.com/Optolith/entity-descriptions/commit/3d8d229e76ad231642571f7ae4e5226955ed3c5d))
+* stricter types for body sections ([d3d747f](https://github.com/Optolith/entity-descriptions/commit/d3d747f75c2317aabb50576fbe59a99297ad3110))
+* zibilja ritual description generator ([7ca36b9](https://github.com/Optolith/entity-descriptions/commit/7ca36b9af3505cf3e0c7b0f339dd024aab60dfd4))
+
+
+### Bug Fixes
+
+* add missing alternative names and special ([546cc85](https://github.com/Optolith/entity-descriptions/commit/546cc852cd41526ccd0185bd1b94c9f3f03c41cb))
+* missing familiar's trick LP cost ([00348aa](https://github.com/Optolith/entity-descriptions/commit/00348aaedfee61a023266aa9d1ffb96fe27a4d2a))
+* missing note for cost by primary patron ([a10d785](https://github.com/Optolith/entity-descriptions/commit/a10d785a53fa64fe31f345065b3628be78e5bb55))
+* poison application types and addiction ([03d8854](https://github.com/Optolith/entity-descriptions/commit/03d885404e31b4d610ff5bbf7a94fbfcb0fdd2aa))
+* register magical rune descriptor correctly ([84705eb](https://github.com/Optolith/entity-descriptions/commit/84705eb75f96c0aa7986a16e02daa91699d19f52))
+* register previously existing generators ([b3253e0](https://github.com/Optolith/entity-descriptions/commit/b3253e070ae8e49cf72efa430798f844cb37dffd))
+* register sex practice descriptor ([7a7f9fe](https://github.com/Optolith/entity-descriptions/commit/7a7f9fef45da06e6a08dbbe54838d00afbd485e5))
+* render errata ([763e7bf](https://github.com/Optolith/entity-descriptions/commit/763e7bf1542dd4f6cfc70f6a0915e1214c3d6d58))
+* sort translated lists ([f1df86f](https://github.com/Optolith/entity-descriptions/commit/f1df86f7b941e7ea26677eedb0443566672cbe96))
+
+## [0.2.1](https://github.com/Optolith/entity-descriptions/compare/v0.2.0...v0.2.1) (2024-10-07)
+
+
+### Bug Fixes
+
+* default database accessors type always throws error when function is called ([31bcb85](https://github.com/Optolith/entity-descriptions/commit/31bcb850a7d962417a65c4517090fb9c9d581fef))
+
 ## [0.2.0](https://github.com/Optolith/entity-descriptions/compare/v0.1.1...v0.2.0) (2024-10-07)
 
 

package/lib/creator.d.ts

@@ -0,0 +1,32 @@
+import type { EntityMap } from "optolith-database-schema/gen";
+import type { GetInstanceById } from "./helpers/getTypes.js";
+import { LocaleEnvironment } from "./helpers/locale.js";
+import { EntityDescription, RawEntityDescription } from "./index.js";
+/**
+ * A union type of entities with their names as a discriminant property.
+ */
+export type TaggedEntity<ES extends keyof EntityMap> = {
+    [E in ES]: {
+        entity: E;
+        content: EntityMap[E];
+        id: string;
+    };
+}[ES];
+/**
+ * Creates a function that creates the JSON representation of the rules text for
+ * a library entry.
+ */
+export declare const createEntityDescriptionCreator: <ES extends keyof EntityMap, A extends {
+    getInstanceById: GetInstanceById<"Publication">;
+} = {
+    getInstanceById: GetInstanceById<"Publication">;
+}>(fn: EntityDescriptionCreator<ES, A, RawEntityDescription>) => EntityDescriptionCreator<ES, A>;
+/**
+ * A function that creates the JSON representation of the rules text for a
+ * library entry.
+ */
+export type EntityDescriptionCreator<ES extends keyof EntityMap = keyof EntityMap, A extends {
+    getInstanceById: GetInstanceById<"Publication">;
+} = {
+    getInstanceById: GetInstanceById<"Publication">;
+}, R = EntityDescription> = (databaseAccessors: A, locale: LocaleEnvironment, entry: TaggedEntity<ES>) => R | undefined;

package/lib/creator.js

@@ -0,0 +1,72 @@
+import { isNotNullish } from "@elyukai/utils/nullable";
+import { assertExhaustive } from "@elyukai/utils/typeSafety";
+import { getReferencesTranslation } from "./references/index.js";
+const mapRawSectionContent = (mapDefinitionList, section) => {
+    switch (section.type) {
+        case "plain":
+        case "table":
+            return section;
+        case "definitionList":
+            return mapDefinitionList(section);
+        default:
+            return assertExhaustive(section);
+    }
+};
+const mapNestedDefinitionList = (definitionListSection) => ({
+    ...definitionListSection,
+    items: definitionListSection.items.filter(isNotNullish).map(item => ({
+        ...item,
+        value: typeof item.value === "string"
+            ? item.value
+            : item.value
+                .filter(isNotNullish)
+                .map(subsection => mapRawSectionContent(mapNestedDefinitionList, subsection)),
+    })),
+});
+const mapDefinitionList = (section) => ({
+    ...section,
+    items: section.items.filter(isNotNullish).map(item => ({
+        ...item,
+        value: typeof item.value === "string"
+            ? item.value
+            : item.value
+                .filter(isNotNullish)
+                .map(subsection => mapRawSectionContent(mapNestedDefinitionList, subsection)),
+    })),
+});
+const mapRawSection = (section) => {
+    switch (section.type) {
+        case "labeled":
+            return {
+                ...section,
+                value: mapRawSectionContent(mapDefinitionList, section.value),
+            };
+        case "plain":
+        case "table":
+        case "definitionList":
+            return mapRawSectionContent(mapDefinitionList, section);
+        default:
+            return assertExhaustive(section);
+    }
+};
+/**
+ * Creates a function that creates the JSON representation of the rules text for
+ * a library entry.
+ */
+export const createEntityDescriptionCreator = (fn) => (databaseAccessors, locale, entry) => {
+    const rawEntry = fn(databaseAccessors, locale, entry);
+    if (rawEntry === undefined) {
+        return undefined;
+    }
+    return {
+        ...rawEntry,
+        body: rawEntry.body.filter(isNotNullish).map(mapRawSection),
+        errata: rawEntry.errata?.map(({ date, description }) => ({
+            date: date.toLocaleDateString(locale.id),
+            description: description.trim(),
+        })),
+        references: rawEntry.references === undefined
+            ? undefined
+            : getReferencesTranslation(databaseAccessors.getInstanceById, locale, rawEntry.references),
+    };
+};

package/lib/entities/activatable.d.ts

@@ -0,0 +1,52 @@
+import type { ActivatableIdentifier, AdvantageDisadvantagePrerequisites, AdventurePointsValue, ApplicableCombatTechniques, Aspect_ID, CombatSpecialAbilityUsageType, DaggerRitualCost, EnchantmentCost, Errata, GeneralPrerequisites, MagicalSignCost, Penalty, PropertyDeclaration, PublicationRefs, RatedIdentifier, SelectOptions, SpecialRule, Volume } from "optolith-database-schema/gen";
+import type { GetAllInstances, GetInstanceById } from "../helpers/getTypes.js";
+import type { GetAllResolvedNewSkillApplications, GetAllResolvedSelectOptions, GetAllResolvedSkillUses } from "../index.js";
+import type { GetResolvedSelectOptionById } from "./partial/prerequisites/single/activatable.js";
+/**
+ * The base fields for a special ability entity in the database.
+ */
+export type BaseActivatable = {
+    levels?: number;
+    maximum?: number;
+    select_options?: SelectOptions;
+    usage_type?: CombatSpecialAbilityUsageType;
+    penalty?: Penalty;
+    combat_techniques?: ApplicableCombatTechniques;
+    volume?: Volume;
+    cost?: EnchantmentCost | DaggerRitualCost | MagicalSignCost | number;
+    property?: PropertyDeclaration;
+    aspect?: Aspect_ID;
+    prerequisites?: AdvantageDisadvantagePrerequisites | GeneralPrerequisites;
+    ap_value: AdventurePointsValue | number;
+    translations: {
+        [locale: string]: BaseActivatableTranslation;
+    };
+    src: PublicationRefs;
+};
+/**
+ * The base translation fields for a special ability.
+ */
+export type BaseActivatableTranslation = {
+    name: string;
+    name_in_library?: string;
+    rules?: string;
+    range?: string;
+    effect?: string;
+    special_rules?: SpecialRule[];
+    protective_circle?: string;
+    warding_circle?: string;
+    ap_value?: string;
+    ap_value_append?: string;
+    errata?: Errata;
+};
+/**
+ * Get a JSON representation of the rules text for a special ability.
+ */
+export declare const getActivatableEntityDescription: import("../creator.js").EntityDescriptionCreator<"Advantage" | "Disadvantage" | "AdvancedCombatSpecialAbility" | "AdvancedKarmaSpecialAbility" | "AdvancedMagicalSpecialAbility" | "AdvancedSkillSpecialAbility" | "AncestorGlyph" | "ArcaneOrbEnchantment" | "AttireEnchantment" | "Beutelzauber" | "BlessedTradition" | "BowlEnchantment" | "BrawlingSpecialAbility" | "CauldronEnchantment" | "CeremonialItemSpecialAbility" | "ChronicleEnchantment" | "CombatSpecialAbility" | "CombatStyleSpecialAbility" | "CommandSpecialAbility" | "DaggerRitual" | "FamiliarSpecialAbility" | "FatePointSexSpecialAbility" | "FatePointSpecialAbility" | "FoolsHatEnchantment" | "GeneralSpecialAbility" | "Haubenzauber" | "InstrumentEnchantment" | "KarmaSpecialAbility" | "Krallenkettenzauber" | "Kristallkugelzauber" | "LiturgicalStyleSpecialAbility" | "LycantropicGift" | "MagicalSign" | "MagicalSpecialAbility" | "MagicalTradition" | "MagicStyleSpecialAbility" | "OrbEnchantment" | "PactGift" | "ProtectiveWardingCircleSpecialAbility" | "RingEnchantment" | "Sermon" | "SexSpecialAbility" | "SickleRitual" | "SikaryanDrainSpecialAbility" | "SkillStyleSpecialAbility" | "SpellSwordEnchantment" | "StaffEnchantment" | "ToyEnchantment" | "Trinkhornzauber" | "VampiricGift" | "Vision" | "WandEnchantment" | "WeaponEnchantment", {
+    getInstanceById: GetInstanceById<"Publication" | "Subject" | ActivatableIdentifier["kind"] | RatedIdentifier["kind"] | "TradeSecret" | "Aspect" | "Property" | "Race" | "Culture" | "State" | "Enhancement" | "PactCategory" | "PactDomain" | "SocialStatus" | "Weapon">;
+    getAllInstances: GetAllInstances<"Script">;
+    getResolvedSelectOptionById: GetResolvedSelectOptionById;
+    getAllResolvedSelectOptions: GetAllResolvedSelectOptions;
+    getAllResolvedNewSkillApplications: GetAllResolvedNewSkillApplications;
+    getAllResolvedSkillUses: GetAllResolvedSkillUses;
+}, import("../index.js").EntityDescription>;