@optolith/entity-descriptions 0.14.0 → 0.16.0

package/lib/entities/equipmentPackage.d.ts

@@ -5,4 +5,4 @@ import type { GetInstanceById } from "../helpers/getTypes.js";
  */
 export declare const getEquipmentPackageEntityDescription: import("../creator.js").EntityDescriptionCreator<"EquipmentPackage", {
     getInstanceById: GetInstanceById<"Publication" | EquipmentIdentifier["kind"] | "SocialStatus">;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;

package/lib/entities/experienceLevel.d.ts

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

package/lib/entities/focusRule.d.ts

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

package/lib/entities/influence.d.ts

@@ -8,4 +8,4 @@ export declare const getInfluenceEntityDescription: import("../creator.js").Enti
     getInstanceById: GetInstanceById<"Publication" | "Influence" | "Race" | ActivatableIdentifier["kind"] | "Aspect">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"ProfessionVersion">;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;

package/lib/entities/liturgicalChant.d.ts

@@ -7,7 +7,7 @@ import type { IdMap } from "../index.js";
 export declare const getBlessingEntityDescription: import("../creator.js").EntityDescriptionCreator<"Blessing", {
     getInstanceById: GetInstanceById<"Publication" | "TargetCategory">;
     getAllInstances: GetAllInstances<"BlessedTradition">;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a liturgical chant.
  */
@@ -15,7 +15,7 @@ export declare const getLiturgicalChantEntityDescription: import("../creator.js"
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Aspect" | "BlessedTradition" | "DerivedCharacteristic" | RatedIdentifier["kind"] | "Enhancement" | "FocusRule">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"Enhancement">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a ceremony.
  */
@@ -23,4 +23,4 @@ export declare const getCeremonyEntityDescription: import("../creator.js").Entit
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Aspect" | "BlessedTradition" | "DerivedCharacteristic" | RatedIdentifier["kind"] | "Enhancement" | "FocusRule">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"Enhancement">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;

package/lib/entities/optionalRule.d.ts

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

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

@@ -1,7 +1,7 @@
 import type { CommonnessRatedAdvantageDisadvantage } from "@optolith/database-schema/gen";
 import type { StdReader } from "../../env.js";
 import type { TranslationKeysWithoutParams } from "../../helpers/translate.js";
-import type { RawDefinitionListEntityDescriptionSectionItem } from "../../index.js";
+import type { RawDefinitionListEntityDescriptionSectionItem } from "../../rawEntityDescription.js";
 /**
  * Render the names of either commonness-rated advantages or commonness-rated disadvantages.
  */

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

@@ -1,6 +1,6 @@
 import type { ImprovementCost, RatedIdentifier, SkillWithEnhancementsIdentifier } from "@optolith/database-schema/gen";
 import type { StdReader } from "../../env.js";
-import type { RawEntityDescriptionSection } from "../../index.js";
+import type { RawEntityDescriptionSection } from "../../rawEntityDescription.js";
 /**
  * Render the enhancements section for an entity description, if applicable.
  */

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

@@ -1,3 +1,4 @@
+import { Reader } from "@elyukai/utils/reader";
 import type { AlternativeName, LaboratoryLevel, Resistance } from "@optolith/database-schema/gen";
 import type { GetInstanceById } from "../../helpers/getTypes.js";
 import type { LocaleMap, Translate, TranslateMap } from "../../helpers/translate.js";
@@ -22,7 +23,9 @@ export declare const renderChance: (translate: Translate, translateMap: Translat
 /**
  * Renders a list of alternative names into a localized string, or returns undefined if there are no alternative names.
  */
-export declare const renderAlternativeNames: (translate: Translate, alternativeNames: AlternativeName[] | undefined) => {
-    label: string;
-    value: string;
+export declare const renderAlternativeNames: (alternativeNames: AlternativeName[] | undefined) => {
+    label: Reader<{
+        translate: Translate;
+    }, string>;
+    value: Reader<unknown, string>;
 } | undefined;

package/lib/entities/partial/herbary.js

@@ -1,8 +1,10 @@
 import { isNotEmpty } from "@elyukai/utils/array/nonEmpty";
+import { Reader } from "@elyukai/utils/reader";
 import { assertExhaustive } from "@elyukai/utils/typeSafety";
 import { renderDice } from "./dice.js";
 import { attributedName } from "./markdown.js";
 import { parensIf } from "./rated/activatable/parensIf.js";
+import { translateR } from "./reader.js";
 import { MISSING_VALUE } from "./unknown.js";
 /**
  * Renders a laboratory level into a localized string.
@@ -56,11 +58,11 @@ export const renderChance = (translate, translateMap, item, includePercentage =
 /**
  * Renders a list of alternative names into a localized string, or returns undefined if there are no alternative names.
  */
-export const renderAlternativeNames = (translate, alternativeNames) => alternativeNames === undefined || !isNotEmpty(alternativeNames)
+export const renderAlternativeNames = (alternativeNames) => alternativeNames === undefined || !isNotEmpty(alternativeNames)
     ? undefined
     : {
-        label: translate(".input {$hiddenCount :number} {{Alternative Names}}", {
+        label: translateR(".input {$hiddenCount :number} {{Alternative Names}}", {
             hiddenCount: alternativeNames.length,
         }),
-        value: alternativeNames.map(name => name.name + parensIf(name.region)).join(", "),
+        value: Reader.of(alternativeNames.map(name => name.name + parensIf(name.region)).join(", ")),
     };

package/lib/entities/partial/prerequisites/index.d.ts

@@ -1,7 +1,7 @@
 import { Reader } from "@elyukai/utils/reader";
 import type { ActivatableIdentifier, AdvantageDisadvantagePrerequisites, AnimistPowerPrerequisites, ArcaneTraditionPrerequisites, DerivedCharacteristicPrerequisites, EnhancementPrerequisites, GeneralPrerequisites, GeodeRitualPrerequisites, InfluencePrerequisites, LanguagePrerequisites, LiturgyPrerequisites, PersonalityTraitPrerequisites, PlainGeneralPrerequisites, ProfessionPrerequisites, ProfessionVariantPrerequisites, PublicationPrerequisites, SpellworkPrerequisites } from "@optolith/database-schema/gen";
 import type { StdEnv, StdReader } from "../../../env.js";
-import type { RawEntityDescriptionBadge } from "../../../index.js";
+import type { RawEntityDescriptionBadge } from "../../../rawEntityDescription.js";
 import { printAdvantageDisadvantagePrerequisiteGroup, printAnimistPowerPrerequisiteGroup, printArcaneTraditionPrerequisiteGroup, printDerivedCharacteristicPrerequisiteGroup, printEnhancementPrerequisiteGroup, printGeneralPrerequisiteGroup, printGeodeRitualPrerequisiteGroup, printInfluencePrerequisiteGroup, printLanguagePrerequisiteGroup, printLiturgyPrerequisiteGroup, printPersonalityTraitPrerequisiteGroup, printProfessionPrerequisiteGroup, printPublicationPrerequisiteGroup, printSpellworkPrerequisiteGroup } from "./prerequisiteGroups.js";
 type DeriveEnvF<T extends (...args: any[]) => any> = ReturnType<T> extends Reader<infer E, unknown> ? E : never;
 /**

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

@@ -1,6 +1,6 @@
 import type { ActivatableSkillEffect } from "@optolith/database-schema/gen";
 import type { StdReader } from "../../../../env.js";
-import type { RawDefinitionListEntityDescriptionSectionItem } from "../../../../index.js";
+import type { RawDefinitionListEntityDescriptionSectionItem } from "../../../../rawEntityDescription.js";
 /**
  * Gets the text for the effect of an activatable skill.
  */

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

@@ -1,6 +1,6 @@
 import type { FastOneTimePerformanceParameters, FastSustainedPerformanceParameters, OneTimePerformanceParameters, ResponsiveTextOptional, SlowOneTimePerformanceParameters, SlowSustainedPerformanceParameters } from "@optolith/database-schema/gen";
 import type { StdReader } from "../../../../env.js";
-import type { RawDefinitionListEntityDescriptionSectionItem } from "../../../../index.js";
+import type { RawDefinitionListEntityDescriptionSectionItem } from "../../../../rawEntityDescription.js";
 type RenderedPerformanceParameters = {
     castingTime: string;
     cost: string;

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

@@ -1,6 +1,6 @@
 import type { AffectedTargetCategories } from "@optolith/database-schema/gen";
 import type { StdReader } from "../../../../env.js";
-import { type RawDefinitionListEntityDescriptionSectionItem } from "../../../../index.js";
+import { type RawDefinitionListEntityDescriptionSectionItem } from "../../../../rawEntityDescription.js";
 /**
  * Get the text for the target category.
  */

package/lib/entities/partial/rated/improvementCost.d.ts

@@ -1,6 +1,6 @@
 import type { ImprovementCost } from "@optolith/database-schema/gen";
 import type { StdReader } from "../../../env.js";
-import { type RawDefinitionListEntityDescriptionSectionItem } from "../../../index.js";
+import { type RawDefinitionListEntityDescriptionSectionItem } from "../../../rawEntityDescription.js";
 /**
  * Renders an improvement cost value as a string.
  */

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

@@ -0,0 +1,55 @@
+import { Reader } from "@elyukai/utils/reader";
+import type { StdEnv } from "../../../env.js";
+/**
+ * Returns the text for numeric silverthaler cost.
+ */
+export declare const formatSilverthalers: (value: number) => Reader<StdEnv<"fn", never, never, never> & import("@elyukai/utils/nullable").AnyNonNullish & {
+    translate: import("../../../helpers/translate.js").Translate;
+    responsiveTextSize: import("../responsiveText.js").ResponsiveTextSize;
+}, string>;
+/**
+ * Returns the text for silverthaler cost.
+ */
+export declare const formatArbitrarySilverthalers: (value: string | number) => Reader<StdEnv<"fn", never, never, never> & import("@elyukai/utils/nullable").AnyNonNullish & {
+    translate: import("../../../helpers/translate.js").Translate;
+    responsiveTextSize: import("../responsiveText.js").ResponsiveTextSize;
+}, string>;
+/**
+ * Returns the text for weight in the weight unit of the locale.
+ */
+export declare const formatWeight: (value: number) => Reader<{
+    translate: import("../../../helpers/translate.js").Translate;
+    responsiveTextSize: import("../responsiveText.js").ResponsiveTextSize;
+}, string>;
+/**
+ * Adjusts a weight value according to the locale's measurement adjustments.
+ */
+export declare const adjustWeight: (value: number) => Reader<StdEnv<"ma">, number>;
+/**
+ * Returns the text for weight in the weight unit of the locale.
+ */
+export declare const formatAdjustedWeight: (value: number) => Reader<StdEnv<"ma"> & {
+    translate: import("../../../helpers/translate.js").Translate;
+    responsiveTextSize: import("../responsiveText.js").ResponsiveTextSize;
+}, string>;
+/**
+ * Returns the text for arbitrary weight in the weight unit of the locale.
+ */
+export declare const formatArbitraryWeight: (value: string | number) => Reader<{
+    translate: import("../../../helpers/translate.js").Translate;
+    responsiveTextSize: import("../responsiveText.js").ResponsiveTextSize;
+}, string>;
+/**
+ * Returns the text for adventure points.
+ */
+export declare const formatAdventurePoints: (value: number) => Reader<StdEnv<"fn", never, never, never> & import("@elyukai/utils/nullable").AnyNonNullish & {
+    translate: import("../../../helpers/translate.js").Translate;
+    responsiveTextSize: import("../responsiveText.js").ResponsiveTextSize;
+}, string>;
+/**
+ * Returns the text for arbitrary adventure points.
+ */
+export declare const formatArbitraryAdventurePoints: (value: string | number) => Reader<StdEnv<"fn", never, never, never> & import("@elyukai/utils/nullable").AnyNonNullish & {
+    translate: import("../../../helpers/translate.js").Translate;
+    responsiveTextSize: import("../responsiveText.js").ResponsiveTextSize;
+}, string>;

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

@@ -0,0 +1,56 @@
+import { Reader } from "@elyukai/utils/reader";
+import { formatNumber, responsiveTranslateR, responsiveTranslateSplitR } from "../reader.js";
+/**
+ * Returns the text for numeric silverthaler cost.
+ */
+export const formatSilverthalers = (value) => formatNumber(value).thenW(valueStr => responsiveTranslateSplitR(".input {$value :number} {{{$value} silverthalers}}", "{$value} S", {
+    value,
+}, {
+    value: valueStr,
+}));
+/**
+ * Returns the text for silverthaler cost.
+ */
+export const formatArbitrarySilverthalers = (value) => typeof value === "number"
+    ? formatSilverthalers(value)
+    : responsiveTranslateR("{$value} silverthalers", "{$value} S", {
+        value,
+    });
+/**
+ * Returns the text for weight in the weight unit of the locale.
+ */
+export const formatWeight = (value) => responsiveTranslateR(".input {$value :number} {{{$value} pounds}}", ".input {$value :number} {{{$value} lbs}}", {
+    value,
+});
+/**
+ * Adjusts a weight value according to the locale's measurement adjustments.
+ */
+export const adjustWeight = (value) => Reader.asks((env) => env.measurementAdjustments.stonesMultiplier * value);
+/**
+ * Returns the text for weight in the weight unit of the locale.
+ */
+export const formatAdjustedWeight = (value) => adjustWeight(value).thenW(formatWeight);
+/**
+ * Returns the text for arbitrary weight in the weight unit of the locale.
+ */
+export const formatArbitraryWeight = (value) => typeof value === "number"
+    ? formatWeight(value)
+    : responsiveTranslateR("{$value} pounds", "{$value} lbs", {
+        value,
+    });
+/**
+ * Returns the text for adventure points.
+ */
+export const formatAdventurePoints = (value) => formatNumber(value).thenW(valueStr => responsiveTranslateSplitR(".input {$value :number} {{{$value} Adventure Points}}", "{$value} AP", {
+    value,
+}, {
+    value: valueStr,
+}));
+/**
+ * Returns the text for arbitrary adventure points.
+ */
+export const formatArbitraryAdventurePoints = (value) => typeof value === "number"
+    ? formatAdventurePoints(value)
+    : responsiveTranslateR("{$value} Adventure Points", "{$value} AP", {
+        value,
+    });

package/lib/entities/personalityTrait.d.ts

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

package/lib/entities/poison.d.ts

@@ -9,4 +9,4 @@ export declare const getPoisonEntityDescription: import("../creator.js").EntityD
     getInstanceById: GetInstanceById<"Publication" | "DerivedCharacteristic" | "Disease" | ActivatableIdentifier["kind"] | RatedIdentifier["kind"] | "Race" | "Culture" | "State" | "Enhancement" | "PactCategory" | "PactDomain" | "SocialStatus" | "Aspect" | "Property" | "PersonalityTrait" | "Blessing" | "Cantrip">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;

package/lib/entities/poison.js

@@ -3,7 +3,7 @@ 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 { combatDLItem, createEntityDescriptionCreator } from "../creator.js";
 import { renderDice, renderDiceR } from "./partial/dice.js";
 import { renderAlternativeNames, renderChance, renderLaboratoryLevel, renderResistance, } from "./partial/herbary.js";
 import { renderMathOperationR } from "./partial/mathOperation.js";
@@ -277,7 +277,7 @@ export const getPoisonEntityDescription = createEntityDescriptionCreator(({ getI
             {
                 type: "definitionList",
                 items: [
-                    renderAlternativeNames(translate, translation.alternative_names),
+                    combatDLItem(renderAlternativeNames(translation.alternative_names), locale),
                     {
                         label: translate("Level"),
                         value: typeof level === "number" ? level.toFixed() : level,

package/lib/entities/profession.d.ts

@@ -1,4 +1,5 @@
 import type { MagicalActionIdentifier, ProfessionSpecialAbilityIdentifier, RatedIdentifier } from "@optolith/database-schema/gen";
+import type { StdEnv } from "../env.js";
 import type { GetAllChildInstancesForParent, GetAllInstances, GetInstanceById } from "../helpers/getTypes.js";
 import { type GetResolvedSelectOptionById } from "./partial/prerequisites/single/activatable.js";
 /**
@@ -9,4 +10,4 @@ export declare const getProfessionVersionEntityDescription: import("../creator.j
     getAllInstances: GetAllInstances<"SkillGroup">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"ProfessionPackage" | "ProfessionVariant">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;

package/lib/entities/race.d.ts

@@ -1,5 +1,5 @@
 import type { ActivatableIdentifier, AutomaticAdvantageDisadvantage } from "@optolith/database-schema/gen";
-import type { StdReader } from "../env.js";
+import type { StdEnv, StdReader } from "../env.js";
 import type { CountInstances, GetAllChildInstancesForParent, GetInstanceById } from "../helpers/getTypes.js";
 import { type GetResolvedSelectOptionById } from "./partial/prerequisites/single/activatable.js";
 /**
@@ -14,4 +14,4 @@ export declare const getRaceEntityDescription: import("../creator.js").EntityDes
     countInstances: CountInstances<"Attribute">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"RaceVariant">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;

package/lib/entities/sexPractice.d.ts

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

package/lib/entities/skill.d.ts

@@ -10,4 +10,4 @@ export declare const getSkillEntityDescription: import("../creator.js").EntityDe
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"SkillApplication">;
     getAllResolvedNewSkillApplications: GetAllResolvedNewSkillApplications;
     getAllResolvedSkillUses: GetAllResolvedSkillUses;
-}, import("../index.js").EntityDescription>;
+} & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;

package/lib/entities/spell.d.ts

@@ -1,4 +1,5 @@
 import { type ActivatableIdentifier, type RatedIdentifier } from "@optolith/database-schema/gen";
+import type { StdEnv } from "../env.js";
 import type { GetAllChildInstancesForParent, GetInstanceById } from "../helpers/getTypes.js";
 import { type IdMap } from "../index.js";
 import type { GetResolvedSelectOptionById } from "./partial/prerequisites/single/activatable.js";
@@ -7,7 +8,7 @@ import type { GetResolvedSelectOptionById } from "./partial/prerequisites/single
  */
 export declare const getCantripEntityDescription: import("../creator.js").EntityDescriptionCreator<"Cantrip", {
     getInstanceById: GetInstanceById<"Publication" | "TargetCategory" | "Property" | "MagicalTradition" | "Curriculum">;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a skill.
  */
@@ -15,7 +16,7 @@ export declare const getSpellEntityDescription: import("../creator.js").EntityDe
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic" | RatedIdentifier["kind"] | "Enhancement" | "FocusRule">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"Enhancement">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a ritual.
  */
@@ -23,88 +24,88 @@ export declare const getRitualEntityDescription: import("../creator.js").EntityD
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic" | RatedIdentifier["kind"] | "Enhancement" | "FocusRule">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"Enhancement">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a curse.
  */
 export declare const getCurseEntityDescription: import("../creator.js").EntityDescriptionCreator<"Curse", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "Property" | "DerivedCharacteristic">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for an Elven magical song.
  */
 export declare const getElvenMagicalSongEntityDescription: import("../creator.js").EntityDescriptionCreator<"ElvenMagicalSong", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "Property" | "DerivedCharacteristic" | "Skill">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a domination ritual.
  */
 export declare const getDominationRitualEntityDescription: import("../creator.js").EntityDescriptionCreator<"DominationRitual", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "Property" | "DerivedCharacteristic" | "SkillModificationLevel">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a magical dance.
  */
 export declare const getMagicalDanceEntityDescription: import("../creator.js").EntityDescriptionCreator<"MagicalDance", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "Property" | "DerivedCharacteristic" | "ArcaneBardTradition" | "ArcaneDancerTradition">;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a magical melody.
  */
 export declare const getMagicalMelodyEntityDescription: import("../creator.js").EntityDescriptionCreator<"MagicalMelody", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "Property" | "DerivedCharacteristic" | "Skill" | "ArcaneBardTradition" | "ArcaneDancerTradition">;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a familiar’s trick.
  */
 export declare const getFamiliarsTrickEntityDescription: import("../creator.js").EntityDescriptionCreator<"FamiliarsTrick", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "Property" | "DerivedCharacteristic" | "AnimalType">;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a animist power.
  */
 export declare const getAnimistPowerEntityDescription: import("../creator.js").EntityDescriptionCreator<"AnimistPower", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic" | "AnimistPower" | "Tribe">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a Goede ritual.
  */
 export declare const getGeodeRitualEntityDescription: import("../creator.js").EntityDescriptionCreator<"GeodeRitual", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic" | "Influence" | ActivatableIdentifier["kind"] | "Aspect">;
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a jester trick.
  */
 export declare const getJesterTrickEntityDescription: import("../creator.js").EntityDescriptionCreator<"JesterTrick", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a goblin ritual.
  */
 export declare const getGoblinRitualEntityDescription: import("../creator.js").EntityDescriptionCreator<"GoblinRitual", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a Zibilja ritual.
  */
 export declare const getZibiljaRitualEntityDescription: import("../creator.js").EntityDescriptionCreator<"ZibiljaRitual", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a Bannzeichen.
  */
 export declare const getBannzeichenEntityDescription: import("../creator.js").EntityDescriptionCreator<"Bannzeichen", {
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "Property" | "DerivedCharacteristic">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"BannzeichenOption">;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;
 /**
  * Get a JSON representation of the rules text for a magical rune.
  */
@@ -112,4 +113,4 @@ export declare const getMagicalRuneEntityDescription: import("../creator.js").En
     getInstanceById: GetInstanceById<"Publication" | "Attribute" | "Property" | "DerivedCharacteristic" | "Skill">;
     getChildInstancesForInstanceId: GetAllChildInstancesForParent<"MagicalRuneOption">;
     idMap: IdMap;
-}, import("../index.js").EntityDescription>;
+} & StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;

package/lib/entities/state.d.ts

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

package/lib/entities/tradeSecret.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Get a JSON representation of the rules text for a state.
+ */
+export declare const getTradeSecretEntityDescription: import("../creator.js").EntityDescriptionCreator<"TradeSecret", import("@elyukai/utils/nullable").AnyNonNullish & import("../env.js").StdEnv<"fd" | "t" | "tm" | "ibi", "Publication">, import("../entityDescription.js").EntityDescription<string>>;

package/lib/entities/tradeSecret.js

@@ -0,0 +1,77 @@
+import { Reader } from "@elyukai/utils/reader";
+import { assertExhaustive } from "@elyukai/utils/typeSafety";
+import { createEntityDescriptionCreator } from "../creator.js";
+import { renderDefaultValueMapLabel, renderValueMap } from "./partial/map.js";
+import { evaluateMathOperation } from "./partial/mathOperation.js";
+import { printPlainGeneralPrerequisites } from "./partial/prerequisites/index.js";
+import { translateR } from "./partial/reader.js";
+import { formatAdventurePoints, formatArbitraryAdventurePoints } from "./partial/units/simple.js";
+const renderAdventurePointsValue = (value) => {
+    switch (value.kind) {
+        case "Fixed": {
+            return formatAdventurePoints(value.Fixed);
+        }
+        case "DependingOnActiveInstances":
+            switch (value.DependingOnActiveInstances.kind) {
+                case "Threshold":
+                    return formatAdventurePoints(value.DependingOnActiveInstances.Threshold.normal);
+                case "Expression": {
+                    const { expression, customLabels } = value.DependingOnActiveInstances.Expression;
+                    const values = Array.from({
+                        length: customLabels === undefined ? 3 : customLabels.options.length,
+                    }, (_, index) => evaluateMathOperation(expression, exprValue => {
+                        switch (exprValue.kind) {
+                            case "Constant":
+                                return exprValue.Constant;
+                            case "Active":
+                                return index;
+                            default:
+                                return assertExhaustive(exprValue);
+                        }
+                    }));
+                    if (customLabels !== undefined) {
+                        return renderValueMap(customLabels, 
+                        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- customLabels.options is guaranteed to have at least as many entries as values
+                        (_, index) => Reader.of(values[index]), renderDefaultValueMapLabel, formatArbitraryAdventurePoints);
+                    }
+                    const labels = Array.from({ length: 3 }, (_, index) => `${(index + 1).toFixed()}.`).join("/");
+                    return translateR("{$values}/and so on Adventure Points for the {$labels}/and so on purchase", {
+                        values: values.join("/"),
+                        labels,
+                    });
+                }
+                default:
+                    return assertExhaustive(value.DependingOnActiveInstances);
+            }
+        default:
+            return assertExhaustive(value);
+    }
+};
+/**
+ * Get a JSON representation of the rules text for a state.
+ */
+export const getTradeSecretEntityDescription = createEntityDescriptionCreator((_, env, { content: entry }) => {
+    const translation = env.translateMap(entry.translations);
+    if (translation === undefined) {
+        return undefined;
+    }
+    return {
+        type: "tabular",
+        title: translation.name,
+        className: "trade-secret",
+        labels: {
+            name: translateR("Name"),
+            prerequisites: translateR("Prerequisites"),
+            apValue: translateR("AP Value"),
+        },
+        values: {
+            name: Reader.of(translation.name),
+            prerequisites: entry.prerequisites === undefined
+                ? translateR("none")
+                : printPlainGeneralPrerequisites(entry.prerequisites),
+            apValue: renderAdventurePointsValue(entry.ap_value),
+        },
+        errata: translation.errata,
+        references: entry.src,
+    };
+});