@optolith/entity-descriptions 0.8.0 → 0.9.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.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/poison.js

@@ -69,7 +69,7 @@ const renderAddiction = (translate, translateMap, format, getInstanceById, addic
                 default:
                     return assertExhaustive(withdrawalPrevention.interval);
             }
-        })()),
+        })(), true),
     })),
 ]
     .filter(isNotNullish)
@@ -222,6 +222,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);
     }