@optolith/entity-descriptions 0.8.0 → 0.9.1

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 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.9.1](https://github.com/Optolith/entity-descriptions/compare/v0.9.0...v0.9.1) (2026-09-11)
+
+### Bug Fixes
+
+* missing general poison note ([3d0085d](https://github.com/Optolith/entity-descriptions/commit/3d0085dbc1435bad216be21a421f31ee2ab5be69))
+* missing unit in poison time spans ([942425f](https://github.com/Optolith/entity-descriptions/commit/942425f3ba9586671ab19f3be7b7cc2532746cc6))
+## [0.9.0](https://github.com/Optolith/entity-descriptions/compare/v0.8.0...v0.9.0) (2026-09-11)
+
+### ⚠ BREAKING CHANGES
+
+* **deps:** upgrade to schema 0.58.0
+
+### build
+
+* **deps:** upgrade to schema 0.58.0 ([fe93cf7](https://github.com/Optolith/entity-descriptions/commit/fe93cf72768cf397a671bd4e883b1bd18288697c))
+
+### Features
+
+* use nameInAPValue for animal shape text generation ([d1c8017](https://github.com/Optolith/entity-descriptions/commit/d1c801791532bdcf1004c67d1e8ae5cb53ae4f07))
+
+### Bug Fixes
+
+* render brew for cauldron enchantments ([866703a](https://github.com/Optolith/entity-descriptions/commit/866703a4500a9d6e47a59cf78919aa9ebcbca05a))
+* render translation replacement if available ([6f890fd](https://github.com/Optolith/entity-descriptions/commit/6f890fd9885c070934c32db5dc5b745a86b46ac8))
+* time interval display when value is 1 ([ada5cc7](https://github.com/Optolith/entity-descriptions/commit/ada5cc768286ced1a26bacf18a4c16a3d289aa40))
 ## [0.8.0](https://github.com/Optolith/entity-descriptions/compare/v0.7.2...v0.8.0) (2026-09-10)
 
 ### ⚠ BREAKING CHANGES

package/lib/entities/activatable.d.ts

@@ -1,4 +1,4 @@
-import type { ActivatableIdentifier, AdvancedSpecialAbility, AdvantageDisadvantagePrerequisites, AdventurePointsValue, ApplicableCombatTechniques, Aspect_ID, DaggerRitualCost, EnchantmentCost, Errata, GeneralPrerequisites, MagicalSignCost, Penalty, PropertyDeclaration, PublicationRefs, RatedIdentifier, SelectOptions, SpecialRule, Volume } from "@optolith/database-schema/gen";
+import type { ActivatableIdentifier, AdvancedSpecialAbility, AdvantageDisadvantagePrerequisites, AdventurePointsValue, ApplicableCombatTechniques, Aspect_ID, Brew_ID, DaggerRitualCost, EnchantmentCost, Errata, GeneralPrerequisites, MagicalSignCost, Penalty, PropertyDeclaration, PublicationRefs, RatedIdentifier, SelectOptions, SpecialRule, Volume } from "@optolith/database-schema/gen";
 import { Case } from "tsondb/schema/gen";
 import type { GetAllInstances, GetInstanceById } from "../helpers/getTypes.js";
 import type { GetAllResolvedNewSkillApplications, GetAllResolvedSelectOptions, GetAllResolvedSkillUses } from "../index.js";
@@ -17,6 +17,7 @@ export type BaseActivatable = {
     penalty?: Penalty;
     combat_techniques?: ApplicableCombatTechniques;
     volume?: Volume;
+    brew?: Brew_ID;
     cost?: EnchantmentCost | DaggerRitualCost | MagicalSignCost | number;
     property?: PropertyDeclaration;
     aspect?: Aspect_ID;
@@ -47,7 +48,7 @@ export type BaseActivatableTranslation = {
  * 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" | "Hauerkettenzauber" | "InstrumentEnchantment" | "KarmaSpecialAbility" | "Keulenzauber" | "Krallenkettenzauber" | "Kristallkugelzauber" | "LiturgicalStyleSpecialAbility" | "LycantropicGift" | "MagicalSign" | "MagicalSpecialAbility" | "MagicalTradition" | "MagicStyleSpecialAbility" | "OrbEnchantment" | "PactGift" | "ProtectiveWardingCircleSpecialAbility" | "RingEnchantment" | "Schweinetrommelzauber" | "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" | "Patron" | "PersonalityTrait" | "Blessing">;
+    getInstanceById: GetInstanceById<"Publication" | "Subject" | ActivatableIdentifier["kind"] | RatedIdentifier["kind"] | "TradeSecret" | "Aspect" | "Property" | "Race" | "Culture" | "State" | "Enhancement" | "PactCategory" | "PactDomain" | "SocialStatus" | "Weapon" | "Patron" | "PersonalityTrait" | "Blessing" | "Brew">;
     getAllInstances: GetAllInstances<"Script">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
     getAllResolvedSelectOptions: GetAllResolvedSelectOptions;

package/lib/entities/activatable.js

@@ -21,7 +21,7 @@ import { printAdvantageDisadvantagePrerequisites, printGeneralPrerequisites, } f
 import { printActivatableName, } from "./partial/prerequisites/single/activatable.js";
 import { renderStandaloneCostMap } from "./partial/rated/activatable/cost.js";
 import { parensIf } from "./partial/rated/activatable/parensIf.js";
-import { attributedNameR, localeSortR, translateR, } from "./partial/reader.js";
+import { attributedNameR, localeSortR, nameR, translateR, } from "./partial/reader.js";
 import { getResponsiveText, getResponsiveTextOptional, ResponsiveTextSize, } from "./partial/responsiveText.js";
 import { formatTimeSpan } from "./partial/units/timeSpan.js";
 import { MISSING_VALUE } from "./partial/unknown.js";
@@ -305,6 +305,7 @@ const renderVolumeValue = (translate, translateMap, getAllResolvedSelectOptions,
             return assertExhaustive(volume);
     }
 };
+const renderBrew = (brew) => nameR("Brew", brew).map(name => name ?? MISSING_VALUE);
 const renderArcaneEnergyCost = (translate, translateMap, format, localeJoin, responsiveTextSize, levels, cost) => {
     switch (cost.kind) {
         case "Fixed": {
@@ -318,7 +319,7 @@ const renderArcaneEnergyCost = (translate, translateMap, format, localeJoin, res
                 ? str => str
                 : str => translate("{$cost} per {$interval}", {
                     cost: str,
-                    interval: formatTimeSpan(translate, translateMap, format, responsiveTextSize, interval.unit, interval.value),
+                    interval: formatTimeSpan(translate, translateMap, format, responsiveTextSize, interval.unit, interval.value, true),
                 });
             const wrapInPerLevel = (() => {
                 if (cost.Fixed.per_level === undefined) {
@@ -360,7 +361,7 @@ const renderArcaneEnergyCost = (translate, translateMap, format, localeJoin, res
         case "Interval":
             return translate("{$cost} per {$interval}", {
                 cost: translate("{$value} AE", { value: cost.Interval.value }),
-                interval: formatTimeSpan(translate, translateMap, format, responsiveTextSize, cost.Interval.interval.unit, cost.Interval.interval.value),
+                interval: formatTimeSpan(translate, translateMap, format, responsiveTextSize, cost.Interval.interval.unit, cost.Interval.interval.value, true),
             });
         case "ActivationAndHalfInterval":
             return additionFormatter(translate("{$value} AE", {
@@ -369,7 +370,7 @@ const renderArcaneEnergyCost = (translate, translateMap, format, localeJoin, res
                 cost: translate("{$value} AE", {
                     value: Math.round(cost.ActivationAndHalfInterval.value / 2),
                 }),
-                interval: formatTimeSpan(translate, translateMap, format, responsiveTextSize, cost.ActivationAndHalfInterval.interval.unit, cost.ActivationAndHalfInterval.interval.value),
+                interval: formatTimeSpan(translate, translateMap, format, responsiveTextSize, cost.ActivationAndHalfInterval.interval.unit, cost.ActivationAndHalfInterval.interval.value, true),
             }));
         case "Indefinite":
             return ((mapNullable(translateMap(cost.Indefinite.translations)?.description, description => getResponsiveText(description, responsiveTextSize)) ?? MISSING_VALUE) +
@@ -846,6 +847,10 @@ export const getActivatableEntityDescription = createEntityDescriptionCreator(({
                         label: translate("Volume"),
                         value: renderVolumeValue(translate, translateMap, () => getAllResolvedSelectOptions(wrappedId), responsiveTextSize, volume),
                     })),
+                    mapNullable(baseEntry.brew, brew => ({
+                        label: translate("Brew"),
+                        value: renderBrew(brew).run(env),
+                    })),
                     mapNullable(baseEntry.cost, cost => renderCost(translate, translateMap, format, locale.join, locale.compare, () => getAllResolvedSelectOptions(wrappedId), responsiveTextSize, baseEntry.levels, cost)),
                     mapNullable(baseEntry.property, property => ({
                         label: translate("Property"),

package/lib/entities/equipmentPackage.js

@@ -161,6 +161,8 @@ const getAtomicEquipmentCost = (entry) => {
                     return "Various";
                 case "DependingOnPurchaseOrSale":
                     return entry.content.cost.DependingOnPurchaseOrSale.purchase;
+                case "Range":
+                    return [entry.content.cost.Range.from, entry.content.cost.Range.to];
                 default:
                     return assertExhaustive(entry.content.cost);
             }

package/lib/entities/partial/adventurePointsValue.js

@@ -101,6 +101,10 @@ export const renderAdventurePointsValue = (locale, getNameForId, getNameForSelec
             }
         }
         case "DerivedFromSelection": {
+            const derivedTranslation = translateMap(value.DerivedFromSelection.translations);
+            if (derivedTranslation?.replacement !== undefined) {
+                return derivedTranslation.replacement;
+            }
             const derivedSelectOptions = entry.select_options?.derived;
             if (derivedSelectOptions === undefined) {
                 return renderFixedSelectOptionsAdventurePointsValue(locale, getAllSelectOptions, getNameForSelectOptionId, item => {
@@ -144,7 +148,7 @@ export const renderAdventurePointsValue = (locale, getNameForId, getNameForSelec
                     return translate("{$values} adventure points for a {$sized} animal shape", {
                         values: sizes.map(size => applyNegative(size.content.ap_value)).join("/"),
                         sized: sizes
-                            .map(size => translateMap(size.content.translations)?.name ?? MISSING_VALUE)
+                            .map(size => translateMap(size.content.translations)?.nameInAPValue ?? MISSING_VALUE)
                             .join("/"),
                     });
                 }

package/lib/entities/partial/dice.d.ts

@@ -4,6 +4,12 @@ import type { Translate } from "../../helpers/translate.js";
  * Renders a dice expression like "2D6" into a localized string.
  */
 export declare const renderDice: (translate: Translate, dice: Dice) => string;
+/**
+ * Renders a dice expression like "2D6" into a localized string.
+ */
+export declare const renderDiceR: (dice: Dice) => import("@elyukai/utils/reader").Reader<{
+    translate: Translate;
+}, string>;
 /**
  * Renders a dice expression with an additional flat modifier, like "2D6+3" or "2D6-1".
  */

package/lib/entities/partial/dice.js

@@ -1,8 +1,13 @@
 import { additionFormatter, subtractionFormatter } from "./mathOperation.js";
+import { translateR } from "./reader.js";
 /**
  * Renders a dice expression like "2D6" into a localized string.
  */
 export const renderDice = (translate, dice) => translate("{$count}D{$sides}", { count: dice.number, sides: dice.sides });
+/**
+ * Renders a dice expression like "2D6" into a localized string.
+ */
+export const renderDiceR = (dice) => translateR("{$count}D{$sides}", { count: dice.number, sides: dice.sides });
 /**
  * Renders a dice expression with an additional flat modifier, like "2D6+3" or "2D6-1".
  */

package/lib/entities/partial/mathOperation.d.ts

@@ -1,3 +1,4 @@
+import { Reader } from "@elyukai/utils/reader";
 import type { MathOperation } from "@optolith/database-schema/gen";
 type UnaryFormatter = (value: string | number) => string;
 type BinaryFormatter = (left: string | number, right: string | number) => string;
@@ -29,6 +30,10 @@ export declare const groupFormatter: UnaryFormatter;
  * Render a math operation as a string, using the provided function to render the values.
  */
 export declare const renderMathOperation: <T, R extends string | number>(operation: MathOperation<T>, renderValue: (value: T) => R, renderDirectValue?: (value: T) => R) => R | string;
+/**
+ * Render a math operation as a string, using the provided function to render the values.
+ */
+export declare const renderMathOperationR: <T, R extends string | number, E>(operation: MathOperation<T>, renderValue: (value: T) => Reader<E, R>, renderDirectValue?: (value: T) => Reader<E, R>) => Reader<E, R | string>;
 /**
  * Evaluate a math operation, using the provided function to evaluate the values.
  */

package/lib/entities/partial/mathOperation.js

@@ -1,3 +1,4 @@
+import { Reader } from "@elyukai/utils/reader";
 import { assertExhaustive } from "@optolith/helpers/typeSafety";
 const printOperand = (operand) => typeof operand === "number" ? operand.toFixed() : operand;
 /**
@@ -72,6 +73,10 @@ export const renderMathOperation = (operation, renderValue, renderDirectValue) =
             return assertExhaustive(operation);
     }
 };
+/**
+ * Render a math operation as a string, using the provided function to render the values.
+ */
+export const renderMathOperationR = (operation, renderValue, renderDirectValue) => Reader.asks(env => renderMathOperation(operation, value => renderValue(value).run(env), renderDirectValue ? value => renderDirectValue(value).run(env) : undefined));
 /**
  * Evaluate a math operation, using the provided function to evaluate the values.
  */

package/lib/entities/poison.js

@@ -1,15 +1,17 @@
 import { ensureNonEmpty } from "@elyukai/utils/array/nonEmpty";
 import { isNotNullish, mapNullable } from "@elyukai/utils/nullable";
+import { Reader } from "@elyukai/utils/reader";
 import { sign } from "@elyukai/utils/string/number";
 import { assertExhaustive } from "@elyukai/utils/typeSafety";
 import { createEntityDescriptionCreator } from "../creator.js";
-import { renderDice } from "./partial/dice.js";
+import { renderDice, renderDiceR } from "./partial/dice.js";
 import { renderAlternativeNames, renderChance, renderLaboratoryLevel, renderResistance, } from "./partial/herbary.js";
-import { renderMathOperation } from "./partial/mathOperation.js";
+import { renderMathOperationR } from "./partial/mathOperation.js";
 import { printPlainGeneralPrerequisites } from "./partial/prerequisites/index.js";
 import { parensIf } from "./partial/rated/activatable/parensIf.js";
+import { translateMapR, translateR } from "./partial/reader.js";
 import { ResponsiveTextSize } from "./partial/responsiveText.js";
-import { formatTimeSpan } from "./partial/units/timeSpan.js";
+import { formatTimeSpan, formatTimeSpanR } from "./partial/units/timeSpan.js";
 import { MISSING_VALUE, UNHANDLED_VALUE } from "./partial/unknown.js";
 const renderApplicationType = (translate, localeJoin, localeCompare, applicationType) => translate("{$types} poison", {
     types: localeJoin(applicationType
@@ -69,7 +71,7 @@ const renderAddiction = (translate, translateMap, format, getInstanceById, addic
                 default:
                     return assertExhaustive(withdrawalPrevention.interval);
             }
-        })()),
+        })(), true),
     })),
 ]
     .filter(isNotNullish)
@@ -158,48 +160,48 @@ const renderSourceTypeBasedValues = (translate, translateMap, format, getInstanc
             return assertExhaustive(sourceType);
     }
 };
-const renderStart = (translate, translateMap, start) => {
+const renderStart = (start) => {
     switch (start.kind) {
         case "Immediate":
-            return translate("immediate");
+            return translateR("immediate");
         case "ExpressionBased":
-            return renderMathOperation(start.ExpressionBased.value, value => {
+            return renderMathOperationR(start.ExpressionBased.value, (value) => {
                 switch (value.kind) {
                     case "Constant":
-                        return value.Constant.toFixed();
+                        return Reader.of(value.Constant);
                     case "Dice":
-                        return renderDice(translate, value.Dice);
+                        return renderDiceR(value.Dice);
                     case "CircleOfDamnation":
-                        return translate("CoD");
+                        return translateR("CoD");
                     default:
                         return assertExhaustive(value);
                 }
-            });
+            }).thenW(value => formatTimeSpanR(start.ExpressionBased.unit, value));
         case "Indefinite":
-            return translateMap(start.Indefinite.translations)?.description ?? MISSING_VALUE;
+            return translateMapR(start.Indefinite.translations).map(translation => translation?.description ?? UNHANDLED_VALUE);
         default:
             return assertExhaustive(start);
     }
 };
-const renderDuration = (translate, translateMap, duration) => {
+const renderDuration = (duration) => {
     switch (duration.kind) {
         case "Instant":
-            return translate("instant");
+            return translateR("instant");
         case "ExpressionBased":
-            return renderMathOperation(duration.ExpressionBased.value, value => {
+            return renderMathOperationR(duration.ExpressionBased.value, (value) => {
                 switch (value.kind) {
                     case "Constant":
-                        return value.Constant.toFixed();
+                        return Reader.of(value.Constant);
                     case "Dice":
-                        return renderDice(translate, value.Dice);
+                        return renderDiceR(value.Dice);
                     case "CircleOfDamnation":
-                        return translate("CoD");
+                        return translateR("CoD");
                     default:
                         return assertExhaustive(value);
                 }
-            });
+            }).thenW(value => formatTimeSpanR(duration.ExpressionBased.unit, value));
         case "Indefinite":
-            return translateMap(duration.Indefinite.translations)?.description ?? UNHANDLED_VALUE;
+            return translateMapR(duration.Indefinite.translations).map(translation => translation?.description ?? UNHANDLED_VALUE);
         default:
             return assertExhaustive(duration);
     }
@@ -222,6 +224,11 @@ const renderCost = (translate, translateMap, cost) => {
             })} (${translate("sale")})`;
         case "Indefinite":
             return translateMap(cost.Indefinite.translations)?.description ?? MISSING_VALUE;
+        case "Range":
+            return translate(".input {$from :number} .input {$to :number} {{{$from}–{$to} silverthalers}}", {
+                from: cost.Range.from,
+                to: cost.Range.to,
+            });
         default:
             return assertExhaustive(cost);
     }
@@ -246,6 +253,12 @@ export const getPoisonEntityDescription = createEntityDescriptionCreator(({ getI
     if (translation === undefined) {
         return undefined;
     }
+    const env = {
+        translate,
+        translateMap,
+        format,
+        responsiveTextSize: ResponsiveTextSize.Full,
+    };
     const applicationType = renderApplicationType(translate, localeJoin, localeCompare, entry.application_type);
     const { level, sourceType, ingestion, sideEffect, overdose, legality, special, addiction, typicalIngredients, priceOfIngedientsPerLevel, laboratory, brewingDifficulty, prerequisitesBrewingProcess, tradeSecret, note, } = renderSourceTypeBasedValues(translate, translateMap, format, getInstanceById, entry.source_type);
     return {
@@ -293,14 +306,14 @@ export const getPoisonEntityDescription = createEntityDescriptionCreator(({ getI
                         },
                     {
                         label: translate("Start"),
-                        value: renderStart(translate, translateMap, entry.start),
+                        value: renderStart(entry.start).run(env),
                     },
                     {
                         label: translate("Duration"),
-                        value: renderDuration(translate, translateMap, entry.duration.default) +
+                        value: renderDuration(entry.duration.default).run(env) +
                             (entry.duration.reduced === undefined
                                 ? ""
-                                : ` / ${renderDuration(translate, translateMap, entry.duration.reduced)}`),
+                                : ` / ${renderDuration(entry.duration.reduced).run(env)}`),
                     },
                     legality === undefined
                         ? undefined
@@ -364,12 +377,17 @@ export const getPoisonEntityDescription = createEntityDescriptionCreator(({ getI
                         label: translate("Quality Levels"),
                         value: translate("The poison levels equals the QL."),
                     },
-                    note === undefined
-                        ? undefined
-                        : {
+                    translation.notes !== undefined
+                        ? {
                             label: translate("Note"),
-                            value: note,
-                        },
+                            value: translation.notes,
+                        }
+                        : note === undefined
+                            ? undefined
+                            : {
+                                label: translate("Note"),
+                                value: note,
+                            },
                 ],
             },
         ],