@optolith/entity-descriptions 0.14.0 → 0.15.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 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.15.0](https://github.com/Optolith/entity-descriptions/compare/v0.14.0...v0.15.0) (2026-09-26)
+
+### ⚠ BREAKING CHANGES
+
+* tabular descriptions for most equipment
+
+### Features
+
+* add trade secret entity description ([6379f7d](https://github.com/Optolith/entity-descriptions/commit/6379f7d5fb111ad5960db15b16a17e9d3600bf71))
+* tabular descriptions for most equipment ([3c53e81](https://github.com/Optolith/entity-descriptions/commit/3c53e81d8ca55b47c16ebd4727aa34531f42f965))
 ## [0.14.0](https://github.com/Optolith/entity-descriptions/compare/v0.13.2...v0.14.0) (2026-09-24)
 
 ### ⚠ BREAKING CHANGES

package/lib/creator.d.ts

@@ -1,5 +1,6 @@
+import { type AnyNonNullish } from "@elyukai/utils/nullable";
 import type { EntityMap } from "@optolith/database-schema/gen";
-import type { GetInstanceById } from "./helpers/getTypes.js";
+import type { StdEnv } from "./env.js";
 import type { LocaleEnvironment } from "./helpers/locale.js";
 import type { EntityDescription, RawEntityDescription } from "./index.js";
 import { type PublicationOptions } from "./references/publicationOptions.js";
@@ -17,19 +18,11 @@ export type TaggedEntity<ES extends keyof EntityMap> = {
  * 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>;
+export declare const createEntityDescriptionCreator: <ES extends keyof EntityMap, A = AnyNonNullish, Cols extends string = never>(fn: EntityDescriptionCreator<ES, A, RawEntityDescription<Cols, A>>) => EntityDescriptionCreator<ES, A & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">>;
 /**
  * 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>, options: {
+export type EntityDescriptionCreator<ES extends keyof EntityMap = keyof EntityMap, A = AnyNonNullish, R = EntityDescription<string>> = (databaseAccessors: A, locale: LocaleEnvironment, entry: TaggedEntity<ES>, options: {
     publications: PublicationOptions;
 }) => R | undefined;

package/lib/creator.js

@@ -1,3 +1,4 @@
+import { ensureNonEmpty } from "@elyukai/utils/array/nonEmpty";
 import { isNotNullish } from "@elyukai/utils/nullable";
 import { assertExhaustive } from "@elyukai/utils/typeSafety";
 import { getReferencesTranslation } from "./references/index.js";
@@ -50,18 +51,70 @@ const mapRawSection = (section) => {
             return assertExhaustive(section);
     }
 };
+const mapRawTabular = (raw, env, options) => ({
+    ...raw,
+    category: raw.category === undefined
+        ? undefined
+        : {
+            label: raw.category.label.run(env),
+            value: raw.category.value.run(env),
+        },
+    labels: Object.fromEntries(Object.entries(raw.labels).map(([col, label]) => [col, label.run(env)])),
+    values: Object.fromEntries(Object.entries(raw.values).map(([col, value]) => [col, value.run(env)])),
+    additionalInformation: raw.additionalInformation === undefined
+        ? undefined
+        : raw.additionalInformation
+            .map(info => {
+            if (info === undefined) {
+                return undefined;
+            }
+            const { label: labelR, id, value: valueR } = info;
+            const value = valueR.run(env);
+            if (value === undefined) {
+                return undefined;
+            }
+            return {
+                label: labelR.run(env),
+                id,
+                value,
+            };
+        })
+            .filter(isNotNullish),
+    errata: raw.errata?.map(({ date, description }) => ({
+        date: env.formatDate(new Date(date)),
+        description: description.trim(),
+    })),
+    references: raw.references === undefined
+        ? undefined
+        : getReferencesTranslation(options.publications, raw.references).run(env),
+});
 /**
  * Creates a function that creates the JSON representation of the rules text for
  * a library entry.
  */
 export const createEntityDescriptionCreator = (fn) => (databaseAccessors, locale, entry, options) => {
     const rawEntry = fn(databaseAccessors, locale, entry, options);
+    if (Array.isArray(rawEntry)) {
+        const results = rawEntry
+            .filter(e => isEntryFromIncludedPublication({ src: e.references }, databaseAccessors.getInstanceById, locale.translateMap, options.publications))
+            .map(e => mapRawTabular(e, databaseAccessors, options));
+        return ensureNonEmpty(results);
+    }
     if (rawEntry === undefined ||
         !isEntryFromIncludedPublication({ src: rawEntry.references }, databaseAccessors.getInstanceById, locale.translateMap, options.publications)) {
         return undefined;
     }
+    if (rawEntry.type === "tabular") {
+        return mapRawTabular(rawEntry, databaseAccessors, options);
+    }
     return {
         ...rawEntry,
+        category: rawEntry.category === undefined
+            ? undefined
+            : {
+                label: rawEntry.category.label.run(databaseAccessors),
+                value: rawEntry.category.value.run(databaseAccessors),
+            },
         body: rawEntry.body.filter(isNotNullish).map(mapRawSection),
         errata: rawEntry.errata?.map(({ date, description }) => ({
             date: locale.formatDate(new Date(date)),
@@ -69,6 +122,9 @@ export const createEntityDescriptionCreator = (fn) => (databaseAccessors, locale
         })),
         references: rawEntry.references === undefined
             ? undefined
-            : getReferencesTranslation(databaseAccessors.getInstanceById, options.publications, locale, rawEntry.references),
+            : getReferencesTranslation(options.publications, rawEntry.references).run({
+                ...databaseAccessors,
+                ...locale,
+            }),
     };
 };

package/lib/entities/activatable.d.ts

@@ -1,6 +1,8 @@
 import type { ActivatableIdentifier, ActivatableNameBuilderRules, AdvancedSpecialAbility, AdvantageDisadvantagePrerequisites, AdvantageDisadvantageSubtype, 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 { StdEnv } from "../env.js";
 import type { GetAllInstances, GetInstanceById } from "../helpers/getTypes.js";
+import type { TranslateMap } from "../helpers/translate.js";
 import type { GetAllResolvedNewSkillApplications, GetAllResolvedSelectOptions, GetAllResolvedSkillUses } from "../index.js";
 import { type GetResolvedSelectOptionById } from "./partial/prerequisites/single/activatable.js";
 type AdvancedSpecialAbilityKind = "AdvancedSkillSpecialAbility" | "AdvancedCombatSpecialAbility" | "AdvancedMagicalSpecialAbility" | "AdvancedKarmaSpecialAbility";
@@ -51,11 +53,12 @@ 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" | "Brew" | "Blessing" | "Cantrip" | "FocusRule">;
+    getInstanceById: GetInstanceById<"Publication" | "Subject" | ActivatableIdentifier["kind"] | RatedIdentifier["kind"] | "TradeSecret" | "Aspect" | "Property" | "Race" | "Culture" | "State" | "Enhancement" | "PactCategory" | "PactDomain" | "SocialStatus" | "Weapon" | "Patron" | "PersonalityTrait" | "Brew" | "Blessing" | "Cantrip" | "FocusRule" | "CeremonialItemSpecialAbilityGroup">;
     getAllInstances: GetAllInstances<"Script">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
     getAllResolvedSelectOptions: GetAllResolvedSelectOptions;
     getAllResolvedNewSkillApplications: GetAllResolvedNewSkillApplications;
     getAllResolvedSkillUses: GetAllResolvedSkillUses;
-}, import("../index.js").EntityDescription>;
+    translateMap: TranslateMap;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;
 export {};

package/lib/entities/activatable.js

@@ -22,7 +22,7 @@ import { getDerivedFocusRuleBadgeFromPrerequisites, printAdvantageDisadvantagePr
 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, nameR, translateR } from "./partial/reader.js";
+import { attributedNameR, customNameR, 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";
@@ -831,6 +831,12 @@ export const getActivatableEntityDescription = createEntityDescriptionCreator(({
             }
             : name => `${name} I–${romanize(levels)}`;
     return {
+        category: entityName === "CeremonialItemSpecialAbility" && entry.associatedItem !== undefined
+            ? {
+                label: attributedNameR("category", "CeremonialItemSpecialAbilityGroup", entry.associatedItem).map(name => name ?? MISSING_VALUE),
+                value: customNameR(t => t.nameForSorting, "CeremonialItemSpecialAbilityGroup", entry.associatedItem).map(name => name ?? MISSING_VALUE),
+            }
+            : undefined,
         title: addLevels(makeTraditionName(translation.name_in_library ?? translation.name + parensIf(translation.additionalName))),
         subtitle: mapNullable(baseEntry.subtype, subtype => renderAdvantageDisadvantageSubtype(subtype).run(env)) ??
             mapNullable(baseEntry.usage_type, usageType => renderCombatSpecialAbilityType(usageType).run(env)),

package/lib/entities/alternativeRule.d.ts

@@ -4,4 +4,4 @@ import type { GetInstanceById } from "../helpers/getTypes.js";
  */
 export declare const getAlternativeRuleEntityDescription: import("../creator.js").EntityDescriptionCreator<"AlternativeRule", {
     getInstanceById: GetInstanceById<"Publication" | "PlayerType">;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;

package/lib/entities/attribute.d.ts

@@ -1,6 +1,4 @@
 /**
  * Get a JSON representation of the rules text for an attribute.
  */
-export declare const getAttributeEntityDescription: import("../creator.js").EntityDescriptionCreator<"Attribute", {
-    getInstanceById: import("../helpers/getTypes.js").GetInstanceById<"Publication">;
-}, import("../index.js").EntityDescription>;
+export declare const getAttributeEntityDescription: import("../creator.js").EntityDescriptionCreator<"Attribute", import("@elyukai/utils/nullable").AnyNonNullish & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;

package/lib/entities/combatTechnique.d.ts

@@ -4,10 +4,10 @@ import type { GetInstanceById } from "../helpers/getTypes.js";
  */
 export declare const getCloseCombatTechniqueEntityDescription: import("../creator.js").EntityDescriptionCreator<"CloseCombatTechnique", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute">;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a ranged combat technique.
  */
 export declare const getRangedCombatTechniqueEntityDescription: import("../creator.js").EntityDescriptionCreator<"RangedCombatTechnique", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute">;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;

package/lib/entities/condition.d.ts

@@ -1,12 +1,8 @@
 /**
  * Get a JSON representation of the rules text for a condition.
  */
-export declare const getConditionEntityDescription: import("../creator.js").EntityDescriptionCreator<"Condition", {
-    getInstanceById: import("../helpers/getTypes.js").GetInstanceById<"Publication">;
-}, import("../index.js").EntityDescription>;
+export declare const getConditionEntityDescription: import("../creator.js").EntityDescriptionCreator<"Condition", import("@elyukai/utils/nullable").AnyNonNullish & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a meta condition.
  */
-export declare const getMetaConditionEntityDescription: import("../creator.js").EntityDescriptionCreator<"MetaCondition", {
-    getInstanceById: import("../helpers/getTypes.js").GetInstanceById<"Publication">;
-}, import("../index.js").EntityDescription>;
+export declare const getMetaConditionEntityDescription: import("../creator.js").EntityDescriptionCreator<"MetaCondition", import("@elyukai/utils/nullable").AnyNonNullish & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;

package/lib/entities/culture.d.ts

@@ -1,3 +1,4 @@
+import type { StdEnv } from "../env.js";
 import type { GetAllChildInstancesForParent, GetInstanceById } from "../helpers/getTypes.js";
 import type { GetResolvedSelectOptionById } from "./partial/prerequisites/single/activatable.js";
 /**
@@ -7,4 +8,4 @@ export declare const getCultureEntityDescription: import("../creator.js").Entity
     getInstanceById: GetInstanceById<"Publication" | "Advantage" | "Disadvantage" | "Skill" | "Language" | "LanguageSpecialization" | "Script" | "SocialStatus" | "ProfessionVariant" | "MagicalTradition" | "BlessedTradition">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"ProfessionVersion">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;

package/lib/entities/curriculum.d.ts

@@ -8,4 +8,4 @@ export declare const getCurriculumEntityDescription: import("../creator.js").Ent
     getAllInstances: GetAllInstances<"Profession">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"LessonPackage" | "ProfessionVersion" | "ProfessionPackage">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;

package/lib/entities/derivedCharacteristic.d.ts

@@ -4,4 +4,4 @@ import type { GetInstanceById } from "../helpers/getTypes.js";
  */
 export declare const getDerivedCharacteristicEntityDescription: import("../creator.js").EntityDescriptionCreator<"DerivedCharacteristic", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "DerivedCharacteristic">;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;

package/lib/entities/disease.d.ts

@@ -6,4 +6,4 @@ import type { IdMap } from "../index.js";
 export declare const getDiseaseEntityDescription: import("../creator.js").EntityDescriptionCreator<"Disease" | "AnimalDisease", {
     getInstanceById: GetInstanceById<"Publication" | "AnimalType" | "DerivedCharacteristic">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;

package/lib/entities/elixir.d.ts

@@ -7,4 +7,4 @@ import type { GetResolvedSelectOptionById } from "./partial/prerequisites/single
 export declare const getElixirEntityDescription: import("../creator.js").EntityDescriptionCreator<"Elixir", {
     getInstanceById: GetInstanceById<"Publication" | "DerivedCharacteristic" | ActivatableIdentifier["kind"] | RatedIdentifier["kind"] | "Race" | "Culture" | "State" | "Enhancement" | "PactCategory" | "PactDomain" | "SocialStatus" | "Aspect" | "Property" | "PersonalityTrait" | "Blessing" | "Cantrip">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;

package/lib/entities/equipment.d.ts

@@ -1,9 +1,10 @@
 import type { AmmunitionishIdentifier, EquipmentIdentifier, GenMeleeWeapon, GenRangedWeapon, LocaleMeasurementAdjustments } from "@optolith/database-schema/gen";
 import { type TaggedEntity } from "../creator.js";
+import type { StdEnv } from "../env.js";
 import type { GetInstanceById } from "../helpers/getTypes.js";
 import type { LocaleJoin } from "../helpers/locale.js";
-import type { Format, Translate, TranslateMap } from "../helpers/translate.js";
-import type { IdMap, LabeledEntityDescriptionSection, RawEntityDescriptionSectionContent } from "../index.js";
+import { type Format, type Translate, type TranslateMap } from "../helpers/translate.js";
+import { type LabeledEntityDescriptionSection, type RawEntityDescriptionSectionContent } from "../index.js";
 /**
  * Get the name of an equipment item.
  */
@@ -19,7 +20,4 @@ export declare const renderRangedWeapon: <Damage>(translate: Translate, translat
 /**
  * Get a JSON representation of the rules text for equipment.
  */
-export declare const getEquipmentEntityDescription: import("../creator.js").EntityDescriptionCreator<"Weapon" | "Ammunition" | "Armor" | "Animal" | "AnimalCare" | "BandageOrRemedy" | "Book" | "CeremonialItem" | "Clothes" | "ClothingPackage" | "Container" | "EquipmentOfBlessedOnes" | "GemOrPreciousStone" | "IlluminationLightSource" | "IlluminationRefillOrSupply" | "Jewelry" | "Laboratory" | "Liebesspielzeug" | "LuxuryGood" | "MagicalArtifact" | "MusicalInstrument" | "Newspaper" | "OrienteeringAid" | "RopeOrChain" | "Stationery" | "ThievesTool" | "ToolOfTheTrade" | "TravelGearOrTool" | "Vehicle" | "WeaponAccessory" | "WorkingSupernaturalCreature", {
-    getInstanceById: GetInstanceById<"Publication" | "Attribute" | "Reach" | "SocialStatus" | "CloseCombatTechnique" | "RangedCombatTechnique" | "MagicalTradition" | "BlessedTradition" | "DerivedCharacteristic" | AmmunitionishIdentifier["kind"] | "Race" | "Culture" | "Profession" | "Skill">;
-    idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+export declare const getEquipmentEntityDescription: import("../creator.js").EntityDescriptionCreator<"Weapon" | "Ammunition" | "Armor" | "Animal" | "AnimalCare" | "BandageOrRemedy" | "Book" | "CeremonialItem" | "Clothes" | "ClothingPackage" | "Container" | "EquipmentOfBlessedOnes" | "GemOrPreciousStone" | "IlluminationLightSource" | "IlluminationRefillOrSupply" | "Jewelry" | "Laboratory" | "Liebesspielzeug" | "LuxuryGood" | "MagicalArtifact" | "MusicalInstrument" | "Newspaper" | "OrienteeringAid" | "RopeOrChain" | "Stationery" | "ThievesTool" | "ToolOfTheTrade" | "TravelGearOrTool" | "Vehicle" | "WeaponAccessory" | "WorkingSupernaturalCreature", StdEnv<"f" | "fn" | "t" | "tm" | "lj" | "lc" | "rts" | "ibi" | "ma" | "idm", "BlessedTradition" | "MagicalTradition" | "Publication" | "Race" | "Culture" | "SocialStatus" | "Attribute" | "Skill" | "CloseCombatTechnique" | "RangedCombatTechnique" | "Weapon" | "Profession" | "Ammunition" | "DerivedCharacteristic" | "Reach"> & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../index.js").EntityDescription<string>>;