@optolith/entity-descriptions 0.13.2 → 0.15.0

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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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("../index.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,
+    };
+});

package/lib/env.d.ts

@@ -1,14 +1,15 @@
 import type { AnyNonNullish } from "@elyukai/utils/nullable";
 import type { Reader } from "@elyukai/utils/reader";
-import type { ChildEntityMap, EntityMap } from "@optolith/database-schema/gen";
+import type { ChildEntityMap, EntityMap, LocaleMeasurementAdjustments } from "@optolith/database-schema/gen";
 import type { GetResolvedSelectOptionById } from "./entities/partial/prerequisites/single/activatable.js";
 import type { ModifiableParameter } from "./entities/partial/rated/activatable/nonModifiableSuffix.js";
 import type { Speed } from "./entities/partial/rated/activatable/speed.js";
 import type { ResponsiveTextSize } from "./entities/partial/responsiveText.js";
 import { type EnergyUnit } from "./entities/partial/units/energy.js";
 import type { GetAllChildInstancesForParent, GetAllInstances, GetInstanceById } from "./helpers/getTypes.js";
-import type { FormatNumber, LocaleCompare, LocaleJoin } from "./helpers/locale.js";
+import type { FormatDate, FormatNumber, LocaleCompare, LocaleJoin } from "./helpers/locale.js";
 import type { Format, Translate, TranslateMap, TranslationKeysWithoutParams } from "./helpers/translate.js";
+import type { IdMap } from "./index.js";
 import type { PublicationOptions } from "./references/publicationOptions.js";
 /**
  * The standard set of environment properties for readers in this project.
@@ -16,6 +17,7 @@ import type { PublicationOptions } from "./references/publicationOptions.js";
 export type EnvMap<E extends keyof EntityMap = never, AE extends keyof EntityMap = never, CE extends keyof ChildEntityMap = never> = {
     format: Format;
     formatNumber: FormatNumber;
+    formatDate: FormatDate;
     translate: Translate;
     translateMap: TranslateMap;
     localeJoin: LocaleJoin;
@@ -30,6 +32,8 @@ export type EnvMap<E extends keyof EntityMap = never, AE extends keyof EntityMap
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
     publicationOptions: PublicationOptions;
     displayedInProfession: boolean;
+    measurementAdjustments: Required<LocaleMeasurementAdjustments>;
+    idMap: IdMap;
 };
 /**
  * Shortcuts for selecting keys of the shared environment map type.
@@ -37,6 +41,7 @@ export type EnvMap<E extends keyof EntityMap = never, AE extends keyof EntityMap
 export type EnvMapAbbr = {
     f: "format";
     fn: "formatNumber";
+    fd: "formatDate";
     t: "translate";
     tm: "translateMap";
     lj: "localeJoin";
@@ -51,6 +56,8 @@ export type EnvMapAbbr = {
     rso: "getResolvedSelectOptionById";
     po: "publicationOptions";
     dip: "displayedInProfession";
+    ma: "measurementAdjustments";
+    idm: "idMap";
 };
 /**
  * The standard set of environment properties for readers in this project.

package/lib/helpers/locale.d.ts

@@ -31,3 +31,7 @@ export type LocaleJoin = (list: string[], type: LocaleJoinType) => string;
  * A function that formats a number according to the locale’s rules.
  */
 export type FormatNumber = (value: number) => string;
+/**
+ * A function that formats a date according to the locale’s rules.
+ */
+export type FormatDate = (date: Date) => string;