@optolith/entity-descriptions 0.4.22 → 0.4.23

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.4.23](https://github.com/Optolith/entity-descriptions/compare/v0.4.22...v0.4.23) (2026-06-20)
+
+
+### Features
+
+* apply publication options to enhancements ([b4ba358](https://github.com/Optolith/entity-descriptions/commit/b4ba3583b4a7d7c989fc7b1e81d463ded6a50c54))
+* apply publication options to whole entity description ([344c91f](https://github.com/Optolith/entity-descriptions/commit/344c91f2ba54af021d897540d9f074c674cbe0e2))
+* publication options ([5cc4ce1](https://github.com/Optolith/entity-descriptions/commit/5cc4ce1e0a0df96747b162f8010a41d482f199f9))
+
 ## [0.4.22](https://github.com/Optolith/entity-descriptions/compare/v0.4.21...v0.4.22) (2026-06-14)
 
 

package/lib/creator.d.ts

@@ -2,6 +2,7 @@ import type { EntityMap } from "@optolith/database-schema/gen";
 import type { GetInstanceById } from "./helpers/getTypes.js";
 import type { LocaleEnvironment } from "./helpers/locale.js";
 import type { EntityDescription, RawEntityDescription } from "./index.js";
+import { type PublicationOptions } from "./references/publicationOptions.js";
 /**
  * A union type of entities with their names as a discriminant property.
  */
@@ -29,4 +30,6 @@ export type EntityDescriptionCreator<ES extends keyof EntityMap = keyof EntityMa
     getInstanceById: GetInstanceById<"Publication">;
 } = {
     getInstanceById: GetInstanceById<"Publication">;
-}, R = EntityDescription> = (databaseAccessors: A, locale: LocaleEnvironment, entry: TaggedEntity<ES>) => R | undefined;
+}, R = EntityDescription> = (databaseAccessors: A, locale: LocaleEnvironment, entry: TaggedEntity<ES>, options: {
+    publications: PublicationOptions;
+}) => R | undefined;

package/lib/creator.js

@@ -1,6 +1,7 @@
 import { isNotNullish } from "@elyukai/utils/nullable";
 import { assertExhaustive } from "@elyukai/utils/typeSafety";
 import { getReferencesTranslation } from "./references/index.js";
+import { isEntryFromIncludedPublication, } from "./references/publicationOptions.js";
 const mapRawSectionContent = (mapDefinitionList, section) => {
     switch (section.type) {
         case "plain":
@@ -53,9 +54,10 @@ const mapRawSection = (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) {
+export const createEntityDescriptionCreator = (fn) => (databaseAccessors, locale, entry, options) => {
+    const rawEntry = fn(databaseAccessors, locale, entry, options);
+    if (rawEntry === undefined ||
+        !isEntryFromIncludedPublication({ src: rawEntry.references }, databaseAccessors.getInstanceById, locale.translateMap, options.publications)) {
         return undefined;
     }
     return {
@@ -67,6 +69,6 @@ export const createEntityDescriptionCreator = (fn) => (databaseAccessors, locale
         })),
         references: rawEntry.references === undefined
             ? undefined
-            : getReferencesTranslation(databaseAccessors.getInstanceById, locale, rawEntry.references),
+            : getReferencesTranslation(databaseAccessors.getInstanceById, options.publications, locale, rawEntry.references),
     };
 };

package/lib/entities/activatable.d.ts

@@ -46,7 +46,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" | "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", {
+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">;
     getAllInstances: GetAllInstances<"Script">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;

package/lib/entities/liturgicalChant.js

@@ -77,7 +77,7 @@ const getTextForTraditions = (deps, values) => {
                 if (aspects.length === 0) {
                     return attributedStringName;
                 }
-                return `${attributedStringName} (${aspects.join(" and ")})`;
+                return `${attributedStringName} (${deps.localeJoin(aspects, "conjunction")})`;
             }
             default:
                 return assertExhaustive(trad);
@@ -134,8 +134,8 @@ export const getBlessingEntityDescription = createEntityDescriptionCreator(({ ge
 /**
  * Get a JSON representation of the rules text for a liturgical chant.
  */
-export const getLiturgicalChantEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }) => {
-    const { translate, translateMap, compare: localeCompare } = locale;
+export const getLiturgicalChantEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }, options) => {
+    const { translate, translateMap, compare: localeCompare, join: localeJoin } = locale;
     const translation = translateMap(entry.translations);
     if (translation === undefined) {
         return undefined;
@@ -161,6 +161,7 @@ export const getLiturgicalChantEntityDescription = createEntityDescriptionCreato
                     return assertExhaustive(param);
             }
         },
+        publicationOptions: options.publications,
     };
     const { castingTime, cost, range, duration } = renderFastPerformanceParameters(entry.parameters).run(env);
     return {
@@ -181,6 +182,7 @@ export const getLiturgicalChantEntityDescription = createEntityDescriptionCreato
                         translate,
                         translateMap,
                         localeCompare,
+                        localeJoin,
                         getInstanceById,
                     }, entry.traditions),
                     renderImprovementCost(entry.improvement_cost).run(env),
@@ -195,8 +197,8 @@ export const getLiturgicalChantEntityDescription = createEntityDescriptionCreato
 /**
  * Get a JSON representation of the rules text for a ceremony.
  */
-export const getCeremonyEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }) => {
-    const { translate, translateMap, compare: localeCompare } = locale;
+export const getCeremonyEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }, options) => {
+    const { translate, translateMap, compare: localeCompare, join: localeJoin } = locale;
     const translation = translateMap(entry.translations);
     if (translation === undefined) {
         return undefined;
@@ -222,6 +224,7 @@ export const getCeremonyEntityDescription = createEntityDescriptionCreator(({ ge
                     return assertExhaustive(param);
             }
         },
+        publicationOptions: options.publications,
     };
     const { castingTime, cost, range, duration } = renderSlowPerformanceParameters(entry.parameters).run(env);
     return {
@@ -242,6 +245,7 @@ export const getCeremonyEntityDescription = createEntityDescriptionCreator(({ ge
                         translate,
                         translateMap,
                         localeCompare,
+                        localeJoin,
                         getInstanceById,
                     }, entry.traditions),
                     renderImprovementCost(entry.improvement_cost).run(env),

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

@@ -4,4 +4,4 @@ import { type StdReader } from "./reader.js";
 /**
  * Render the enhancements section for an entity description, if applicable.
  */
-export declare const renderEnhancements: (parentId: SkillWithEnhancementsIdentifier, parentImprovementCost: ImprovementCost) => StdReader<RawEntityDescriptionSection | undefined, "t" | "tm" | "lc" | "lj" | "ibi" | "acibp", RatedIdentifier["kind"] | "Enhancement", "Enhancement">;
+export declare const renderEnhancements: (parentId: SkillWithEnhancementsIdentifier, parentImprovementCost: ImprovementCost) => StdReader<RawEntityDescriptionSection | undefined, "t" | "tm" | "lc" | "lj" | "ibi" | "acibp" | "po", RatedIdentifier["kind"] | "Enhancement" | "Publication", "Enhancement">;

package/lib/entities/partial/enhancements.js

@@ -4,6 +4,7 @@ import { compareNumber } from "@elyukai/utils/ordering";
 import { Reader } from "@elyukai/utils/reader";
 import { assertExhaustive } from "@elyukai/utils/typeSafety";
 import { getAdventurePointsForActivation } from "@optolith/adventure-points/improvement-cost";
+import { filterIncludedPublicationEntriesMapR } from "../../references/publicationOptions.js";
 import { printEnhancementPrerequisites } from "./prerequisites/index.js";
 import { getChildInstancesForInstanceIdR, translateMapR, translateR, } from "./reader.js";
 const getEnhancementAPValue = (adventurePoints, parentImprovementCost) => {
@@ -23,7 +24,9 @@ const renderEnhancement = (enhancement, parentImprovementCost) => translateMapR(
 /**
  * Render the enhancements section for an entity description, if applicable.
  */
-export const renderEnhancements = (parentId, parentImprovementCost) => getChildInstancesForInstanceIdR("Enhancement", parentId).thenW(enhancements => Reader.traverse(enhancements.toSorted(on(e => e.content.skill_rating, compareNumber)), enhancement => renderEnhancement(enhancement, parentImprovementCost)).thenW(enhancementDescriptions => {
+export const renderEnhancements = (parentId, parentImprovementCost) => getChildInstancesForInstanceIdR("Enhancement", parentId).thenW(enhancements => filterIncludedPublicationEntriesMapR(enhancements, e => e.content)
+    .thenW(filteredEnhancements => Reader.traverse(filteredEnhancements.toSorted(on(e => e.content.skill_rating, compareNumber)), enhancement => renderEnhancement(enhancement, parentImprovementCost)))
+    .thenW(enhancementDescriptions => {
     const nonNullishDescriptions = enhancementDescriptions.filter(isNotNullish);
     if (nonNullishDescriptions.length === 0) {
         return Reader.of(undefined);

package/lib/entities/partial/rated/activatable/cost.d.ts

@@ -57,7 +57,7 @@ export declare const renderNonModifiableSustainedCost: (value: NonModifiableSust
 } & {
     translate: Translate;
     responsiveTextSize: ResponsiveTextSize;
-} & StdEnv<"t" | "rts" | "tm" | "eu", never, never, never>, string>;
+} & StdEnv<"tm" | "t" | "rts" | "eu", never, never, never>, string>;
 /**
  * Returns the text for the cost of a sustained activatable skill.
  */

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

@@ -4,6 +4,7 @@ import type { IdArgsVariant } from "tsondb/schema/gen";
 import type { GetAllChildInstancesForParent, GetAllInstances, GetInstanceById } from "../../helpers/getTypes.js";
 import type { FormatNumber, LocaleCompare, LocaleJoin, LocaleJoinType } from "../../helpers/locale.js";
 import type { Format, LocaleMap, Translate, TranslateMap, TranslationKeyMatchingParamsOfKey, TranslationKeysWithoutParams, TranslationParamsInArray, Translations } from "../../helpers/translate.js";
+import type { PublicationOptions } from "../../references/publicationOptions.js";
 import type { GetResolvedSelectOptionById } from "./prerequisites/single/activatable.js";
 import type { ModifiableParameter } from "./rated/activatable/nonModifiableSuffix.js";
 import { Speed } from "./rated/activatable/speed.js";
@@ -27,6 +28,7 @@ export type EnvMap<E extends keyof EntityMap = never, AE extends keyof EntityMap
     getAllInstances: GetAllInstances<AE>;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<CE>;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
+    publicationOptions: PublicationOptions;
 };
 /**
  * Shortcuts for selecting keys of the shared environment map type.
@@ -46,6 +48,7 @@ export type EnvMapAbbr = {
     ai: "getAllInstances";
     acibp: "getChildInstancesForInstanceId";
     rso: "getResolvedSelectOptionById";
+    po: "publicationOptions";
 };
 /**
  * The standard set of environment properties for readers in this project.

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

@@ -40,4 +40,4 @@ export declare const replaceTextIfNeeded: (translations: LocaleMap<{
  */
 export declare const appendNoteIfNeeded: (translations: LocaleMap<{
     note?: ResponsiveTextOptional;
-}> | undefined, valueToAppendTo: string) => Reader<StdEnv<"rts" | "tm">, string>;
+}> | undefined, valueToAppendTo: string) => Reader<StdEnv<"tm" | "rts">, string>;

package/lib/entities/partial/units/timeSpan.d.ts

@@ -5,7 +5,7 @@ import { type ResponsiveTextSize } from "../responsiveText.js";
 /**
  * Possible units to use for time spans.
  */
-export type TimeSpanUnit = "Seconds" | "Minutes" | "Hours" | "Days" | "Weeks" | "Months" | "Years" | "Centuries" | "Actions" | "CombatRounds" | "SeductionActions" | "Rounds";
+export type TimeSpanUnit = "Seconds" | "Minutes" | "Hours" | "Days" | "Weeks" | "Months" | "Years" | "Decades" | "Centuries" | "Actions" | "CombatRounds" | "SeductionActions" | "Rounds";
 /**
  * Returns the text for a time span unit.
  */

package/lib/entities/partial/units/timeSpan.js

@@ -9,6 +9,7 @@ const timeSpanUnitTranslationKeys = {
     Weeks: [".input {$value :number} .input {$style :string} {{{$value} weeks}}", "{$value} weeks", ".input {$value :number} .input {$style :string} {{{$value} wks.}}", "{$value} wks."],
     Months: [".input {$value :number} .input {$style :string} {{{$value} months}}", "{$value} months", ".input {$value :number} .input {$style :string} {{{$value} mos.}}", "{$value} mos."],
     Years: [".input {$value :number} .input {$style :string} {{{$value} years}}", "{$value} years", ".input {$value :number} .input {$style :string} {{{$value} yrs.}}", "{$value} yrs."],
+    Decades: [".input {$value :number} .input {$style :string} {{{$value} decades}}", "{$value} decades", ".input {$value :number} .input {$style :string} {{{$value} dcs.}}", "{$value} dcs."],
     Centuries: [".input {$value :number} .input {$style :string} {{{$value} centuries}}", "{$value} centuries", ".input {$value :number} .input {$style :string} {{{$value} cent.}}", "{$value} cent."],
     Actions: [".input {$value :number} .input {$style :string} {{{$value} actions}}", "{$value} actions", ".input {$value :number} .input {$style :string} {{{$value} act}}", "{$value} act"],
     CombatRounds: [".input {$value :number} .input {$style :string} {{{$value} combat rounds}}", "{$value} combat rounds", ".input {$value :number} .input {$style :string} {{{$value} CR}}", "{$value} CR"],

package/lib/entities/spell.js

@@ -127,7 +127,7 @@ export const getCantripEntityDescription = createEntityDescriptionCreator(({ get
 /**
  * Get a JSON representation of the rules text for a skill.
  */
-export const getSpellEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }) => {
+export const getSpellEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }, options) => {
     const { translate, translateMap, compare: localeCompare } = locale;
     const translation = translateMap(entry.translations);
     if (translation === undefined) {
@@ -154,6 +154,7 @@ export const getSpellEntityDescription = createEntityDescriptionCreator(({ getIn
                     return assertExhaustive(param);
             }
         },
+        publicationOptions: options.publications,
     };
     const { castingTime, cost, range, duration } = renderFastPerformanceParameters(entry.parameters).run(env);
     return {
@@ -184,7 +185,7 @@ export const getSpellEntityDescription = createEntityDescriptionCreator(({ getIn
 /**
  * Get a JSON representation of the rules text for a ritual.
  */
-export const getRitualEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }) => {
+export const getRitualEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }, options) => {
     const { translate, translateMap, compare: localeCompare } = locale;
     const translation = translateMap(entry.translations);
     if (translation === undefined) {
@@ -211,6 +212,7 @@ export const getRitualEntityDescription = createEntityDescriptionCreator(({ getI
                     return assertExhaustive(param);
             }
         },
+        publicationOptions: options.publications,
     };
     const { castingTime, cost, range, duration } = renderSlowPerformanceParameters(entry.parameters).run(env);
     return {