@optolith/entity-descriptions 0.11.1 → 0.11.2

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

@@ -2,66 +2,11 @@ import { Reader } from "@elyukai/utils/reader";
 import type { ChildEntityMap, EntityMap, FastSkillModificationLevelConfig, ResponsiveText, ResponsiveTextOptional, SkillModificationLevel, SlowSkillModificationLevelConfig } from "@optolith/database-schema/gen";
 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 type { LocaleCompare, LocaleJoin, LocaleJoinType } from "../../helpers/locale.js";
+import type { Format, LocaleMap, Translate, TranslateMap, TranslationKeyMatchingParamsOfKey, TranslationParamsInArray, Translations } from "../../helpers/translate.js";
 import { Speed } from "./rated/activatable/speed.js";
 import { ResponsiveTextSize } from "./responsiveText.js";
 import { type EnergyUnit } from "./units/energy.js";
-/**
- * The standard set of environment properties for readers in this project.
- */
-export type EnvMap<E extends keyof EntityMap = never, AE extends keyof EntityMap = never, CE extends keyof ChildEntityMap = never> = {
-    format: Format;
-    formatNumber: FormatNumber;
-    translate: Translate;
-    translateMap: TranslateMap;
-    localeJoin: LocaleJoin;
-    localeCompare: LocaleCompare;
-    responsiveTextSize: ResponsiveTextSize;
-    speed: Speed;
-    energyUnit: EnergyUnit;
-    nonModifiableSuffix?: (param: ModifiableParameter) => TranslationKeysWithoutParams;
-    getInstanceById: GetInstanceById<E>;
-    getAllInstances: GetAllInstances<AE>;
-    getChildInstancesForInstanceId: GetAllChildInstancesForParent<CE>;
-    getResolvedSelectOptionById: GetResolvedSelectOptionById;
-    publicationOptions: PublicationOptions;
-};
-/**
- * Shortcuts for selecting keys of the shared environment map type.
- */
-export type EnvMapAbbr = {
-    f: "format";
-    fn: "formatNumber";
-    t: "translate";
-    tm: "translateMap";
-    lj: "localeJoin";
-    lc: "localeCompare";
-    rts: "responsiveTextSize";
-    s: "speed";
-    eu: "energyUnit";
-    nms: "nonModifiableSuffix";
-    ibi: "getInstanceById";
-    ai: "getAllInstances";
-    acibp: "getChildInstancesForInstanceId";
-    rso: "getResolvedSelectOptionById";
-    po: "publicationOptions";
-};
-/**
- * The standard set of environment properties for readers in this project.
- *
- * The keys are abbreviated to keep type annotations short.
- */
-export type StdEnv<K extends keyof EnvMapAbbr = keyof EnvMapAbbr, E extends keyof EntityMap = never, AE extends keyof EntityMap = never, CE extends keyof ChildEntityMap = never> = Pick<EnvMap<E, AE, CE>, EnvMapAbbr[K]>;
-/**
- * Shortcut for a reader with common environment properties.
- *
- * The keys are abbreviated to keep return type annotations short.
- */
-export type StdReader<T, K extends keyof EnvMapAbbr, E extends keyof EntityMap = never, AE extends keyof EntityMap = never, CE extends keyof ChildEntityMap = never> = Reader<StdEnv<K, E, AE, CE>, T>;
 /**
  * Treats the text as a translation string and applies supplied arguments.
  */

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

@@ -1,7 +1,7 @@
 import { Reader } from "@elyukai/utils/reader";
 import type { ResponsiveText, ResponsiveTextOptional, ResponsiveTextReplace } from "@optolith/database-schema/gen";
+import type { StdEnv } from "../../env.js";
 import { type LocaleMap } from "../../helpers/translate.js";
-import { type StdEnv } from "./reader.js";
 /**
  * Whether the entry is displayed in a normal or compressed setting. Normal/full
  * usually means a full library entry display, whether compressed usually means

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

@@ -1,5 +1,5 @@
+import type { StdReader } from "../../../env.js";
 import type { Translate } from "../../../helpers/translate.js";
-import type { StdReader } from "../reader.js";
 import { type ResponsiveTextSize } from "../responsiveText.js";
 type LengthUnit = "Steps" | "Miles";
 /**

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

@@ -1,7 +1,6 @@
-import { Reader } from "@elyukai/utils/reader";
 import type { Case } from "tsondb/schema/gen";
+import type { StdReader } from "../../../env.js";
 import type { Format, LocaleMap, Translate, TranslateMap } from "../../../helpers/translate.js";
-import type { StdEnv } from "../reader.js";
 import { type ResponsiveTextSize } from "../responsiveText.js";
 /**
  * Possible units to use for time spans.
@@ -36,11 +35,11 @@ export declare const formatCombinedTimeSpan: (translate: Translate, translateMap
 /**
  * Returns the text for a time span unit.
  */
-export declare const formatTimeSpanR: (unit: TimeSpanUnitObject | TimeSpanUnit, value: number | string, interval?: boolean) => Reader<StdEnv<"t" | "tm" | "f" | "rts">, string>;
+export declare const formatTimeSpanR: (unit: TimeSpanUnitObject | TimeSpanUnit, value: number | string, interval?: boolean) => StdReader<string, "t" | "tm" | "f" | "rts">;
 /**
  * Returns the text for a time span unit.
  */
 export declare const formatCombinedTimeSpanR: (object: {
     unit: TimeSpanUnitObject;
     value: number | string;
-}, interval?: boolean) => Reader<StdEnv<"t" | "tm" | "f" | "rts">, string>;
+}, interval?: boolean) => StdReader<string, "t" | "tm" | "f" | "rts">;

package/lib/entities/personalityTrait.js

@@ -16,6 +16,13 @@ export const getPersonalityTraitEntityDescription = createEntityDescriptionCreat
     if (translation === undefined) {
         return undefined;
     }
+    const env = {
+        translate,
+        translateMap,
+        getInstanceById,
+        localeCompare: locale.compare,
+        localeJoin: locale.join,
+    };
     return {
         title: `${translation.name} (${translate("Level {$level}", {
             level: romanize(entry.level),
@@ -51,7 +58,7 @@ export const getPersonalityTraitEntityDescription = createEntityDescriptionCreat
                         ? undefined
                         : {
                             label: translate("Prerequisites"),
-                            value: printPersonalityTraitPrerequisites(getInstanceById, locale, entry.prerequisites),
+                            value: printPersonalityTraitPrerequisites(entry.prerequisites).run(env),
                         },
                 ],
             },

package/lib/entities/poison.js

@@ -262,6 +262,10 @@ export const getPoisonEntityDescription = createEntityDescriptionCreator(({ getI
         translate,
         translateMap,
         format,
+        localeJoin,
+        localeCompare,
+        getInstanceById,
+        getResolvedSelectOptionById,
         responsiveTextSize: ResponsiveTextSize.Full,
     };
     const applicationType = renderApplicationType(translate, localeJoin, localeCompare, entry.application_type);
@@ -376,7 +380,7 @@ export const getPoisonEntityDescription = createEntityDescriptionCreator(({ getI
                         : {
                             label: `${translate("AP Value")} (${translate("Trade Secret")})`,
                             value: translate("{$value} AP", { value: tradeSecret.apValue }) +
-                                parensIf(mapNullable(tradeSecret.prerequisites, prerequisites => `${translate("Prerequisites")}: ${printPlainGeneralPrerequisites(getInstanceById, getResolvedSelectOptionById, locale, prerequisites)}`)),
+                                parensIf(mapNullable(tradeSecret.prerequisites, prerequisites => `${translate("Prerequisites")}: ${printPlainGeneralPrerequisites(prerequisites).run(env)}`)),
                         },
                     entry.source_type.kind === "AlchemicalPoison" ||
                         entry.source_type.kind === "AlchemicalPactGiftPoison"

package/lib/entities/profession.js

@@ -385,7 +385,7 @@ const renderSpecialAbilityName = (specialAbility) => Reader.asks(({ translate, t
             else {
                 return isCombinedEnhancementNameComponents(possiblyCombined)
                     ? renderCombinedEnhancementNameComponents(possiblyCombined)
-                    : wrapActivatableInAttributedString(renderCombinedActivatableNameComponents(translateMap, possiblyCombined, false, list => localeJoin(list, "disjunction")), possiblyCombined.id);
+                    : wrapActivatableInAttributedString(renderCombinedActivatableNameComponents(translateMap, possiblyCombined, false, list => localeJoin(list, "disjunction"), "profession"), possiblyCombined.id);
             }
         }
         default:
@@ -538,15 +538,11 @@ const renderProfessionVariantLabel = (base, variant, translations) => translateR
 const renderProfessionVariantText = (base, variant, translation) => translation.full_text !== undefined
     ? Reader.of(translation.full_text)
     : Reader.sequence([
-        Reader.asks(env => variant.prerequisites === undefined
-            ? []
-            : [
-                `${env.translate("Additional Prerequisites")}: ${printProfessionPrerequisites(env.getInstanceById, env.getResolvedSelectOptionById, {
-                    ...env,
-                    join: env.localeJoin,
-                    compare: env.localeCompare,
-                }, variant.prerequisites)}`,
-            ]),
+        variant.prerequisites === undefined
+            ? Reader.of([])
+            : printProfessionPrerequisites(variant.prerequisites).thenW(prerequisitesText => translateR("Additional Prerequisites").map(label => [
+                `${label}: ${prerequisitesText}`,
+            ])),
         renderVariantOption(base, variant, "skill_specialization", renderVariantSkillSpecializationOption),
         renderVariantOption(base, variant, "languages_scripts", renderVariantLanguagesScriptsOption),
         renderVariantOption(base, variant, "combat_techniques", renderVariantCombatTechniquesOption),
@@ -672,11 +668,9 @@ export const getProfessionVersionEntityDescription = createEntityDescriptionCrea
                     },
                     {
                         label: translate("Prerequisites"),
-                        value: renderSinglePackageValue(professionPackages, pkg => Reader.of(pkg.content.prerequisites), deepEqual, prerequisitesLists => Reader.of(prerequisitesLists
-                            .map(prerequisites => prerequisites === undefined
-                            ? translate("none")
-                            : printProfessionPrerequisites(getInstanceById, getResolvedSelectOptionById, locale, prerequisites))
-                            .join(" / "))).run(env),
+                        value: renderSinglePackageValue(professionPackages, pkg => Reader.of(pkg.content.prerequisites), deepEqual, prerequisitesLists => Reader.traverse(prerequisitesLists, prerequisites => prerequisites === undefined
+                            ? translateR("none")
+                            : printProfessionPrerequisites(prerequisites)).map(list => list.join(" / "))).run(env),
                     },
                     {
                         label: translate("Special Abilities"),

package/lib/entities/race.d.ts

@@ -1,7 +1,7 @@
 import type { ActivatableIdentifier, AutomaticAdvantageDisadvantage } from "@optolith/database-schema/gen";
+import type { StdReader } from "../env.js";
 import type { CountInstances, GetAllChildInstancesForParent, GetInstanceById } from "../helpers/getTypes.js";
 import { type GetResolvedSelectOptionById } from "./partial/prerequisites/single/activatable.js";
-import { type StdReader } from "./partial/reader.js";
 /**
  * Render the names of commonness-rated advantages and disadvantages together.
  */

package/lib/entities/race.js

@@ -12,7 +12,7 @@ import { renderCommonnessRatedAdvantagesOrDisadvantages } from "./partial/common
 import { attributedCustomName, attributedName, attributedNameFromTranslation, } from "./partial/markdown.js";
 import { joinPrerequisiteParts } from "./partial/prerequisites/part.js";
 import { printActivatableName, } from "./partial/prerequisites/single/activatable.js";
-import { getInstanceByIdR, translateMapR, } from "./partial/reader.js";
+import { getInstanceByIdR, translateMapR } from "./partial/reader.js";
 import { MISSING_VALUE } from "./partial/unknown.js";
 const renderBaseValues = (values) => Reader.traverse(Object.entries(values), ([id, { value }]) => getInstanceByIdR("DerivedCharacteristic", id).thenW(derivedCharacteristic => translateMapR(derivedCharacteristic?.translations).thenW(translation => Reader.asks(({ translate }) => [
     derivedCharacteristic?.position ?? 0,
@@ -90,24 +90,28 @@ const renderVariantValues = (label, variants, selector, renderValue, translation
         return undefined;
     }
 });
-const renderAutomaticAdvantagesOrDisadvantages = (entity, items, emptyString) => Reader.asks(({ translate, translateMap, getInstanceById, getResolvedSelectOptionById, localeCompare }) => items === undefined || !isNotEmpty(items)
-    ? emptyString
-    : joinPrerequisiteParts(translate, translateMap, localeCompare, items
-        .map(item => printActivatableName(getInstanceById, translate, Case(entity, item.id), item.options, item.level, getResolvedSelectOptionById, true))
-        .filter(isNotNullish)
-        .map(nameComponents => ({
+const renderAutomaticAdvantagesOrDisadvantages = (entity, items, emptyString) => items === undefined || !isNotEmpty(items)
+    ? Reader.of(emptyString)
+    : Reader.traverse(items, (item) => printActivatableName(Case(entity, item.id), item.options, item.level).with(env => ({
+        ...env,
+        displayedInProfession: true,
+    })))
+        .map(renderedItems => renderedItems.filter(isNotNullish).map(nameComponents => ({
         type: "activatable",
         part: { value: nameComponents, sentenceType: undefined, isMeta: false },
-    }))));
+    })))
+        .thenW(joinPrerequisiteParts);
 /**
  * Render the names of commonness-rated advantages and disadvantages together.
  */
-export const renderAutomaticAdvantagesAndDisadvantages = (advantages, disadvantages, emptyString) => Reader.asks(({ translate, translateMap, getInstanceById, getResolvedSelectOptionById, localeCompare }) => mapNullable(ensureNonEmpty([["Advantage", advantages], ["Disadvantage", disadvantages]].flatMap(([entity, items]) => items
-    ?.map(item => printActivatableName(getInstanceById, translate, Case(entity, item.id), item.options, item.level, getResolvedSelectOptionById, true))
-    .filter(isNotNullish) ?? [])), renderedItems => joinPrerequisiteParts(translate, translateMap, localeCompare, renderedItems.map(nameComponents => ({
+export const renderAutomaticAdvantagesAndDisadvantages = (advantages, disadvantages, emptyString) => Reader.traverse([["Advantage", advantages], ["Disadvantage", disadvantages]], ([entity, items]) => Reader.traverse(items ?? [], (item) => printActivatableName(Case(entity, item.id), item.options, item.level).with(env => ({
+    ...env,
+    displayedInProfession: true,
+})))
+    .map(renderedItems => renderedItems.filter(isNotNullish))).thenW((items) => mapNullable(ensureNonEmpty(items.flat()), safeItems => joinPrerequisiteParts(safeItems.map(nameComponents => ({
     type: "activatable",
     part: { value: nameComponents, sentenceType: undefined, isMeta: false },
-})))) ?? emptyString);
+})))) ?? Reader.of(emptyString));
 const renderCommonCultures = (items) => Reader.asks(({ translate, translateMap, getInstanceById, localeCompare }) => items === undefined || !isNotEmpty(items)
     ? translate("none")
     : items

package/lib/entities/spell.js

@@ -604,6 +604,7 @@ export const getAnimistPowerEntityDescription = createEntityDescriptionCreator((
         format,
         getInstanceById,
         localeJoin: locale.join,
+        localeCompare: locale.compare,
         energyUnit: "ArcaneEnergy",
         responsiveTextSize: ResponsiveTextSize.Full,
     };
@@ -611,7 +612,7 @@ export const getAnimistPowerEntityDescription = createEntityDescriptionCreator((
     const levels = entry.levels?.length ?? 1;
     const prerequisites = entry.prerequisites === undefined
         ? undefined
-        : printAnimistPowerPrerequisites(getInstanceById, locale, entry.prerequisites);
+        : printAnimistPowerPrerequisites(entry.prerequisites).run(env);
     const additionalEffectsFromLevels = entry.levels
         ?.map(level => translateMap(level.translations)?.effect)
         .filter(isNotNullish)
@@ -690,7 +691,9 @@ export const getGeodeRitualEntityDescription = createEntityDescriptionCreator(({
         translateMap,
         format,
         getInstanceById,
+        getResolvedSelectOptionById,
         localeJoin: locale.join,
+        localeCompare: locale.compare,
         energyUnit: "ArcaneEnergy",
         responsiveTextSize: ResponsiveTextSize.Full,
     };
@@ -721,7 +724,7 @@ export const getGeodeRitualEntityDescription = createEntityDescriptionCreator(({
                         ? undefined
                         : {
                             label: translate("Prerequisites"),
-                            value: printGeodeRitualPrerequisites(getInstanceById, getResolvedSelectOptionById, locale, entry.prerequisites),
+                            value: printGeodeRitualPrerequisites(entry.prerequisites).run(env),
                         },
                     renderProperty(entry.property).run(env),
                     {

package/lib/env.d.ts

@@ -0,0 +1,66 @@
+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 { 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 { Format, Translate, TranslateMap, TranslationKeysWithoutParams } from "./helpers/translate.js";
+import type { PublicationOptions } from "./references/publicationOptions.js";
+/**
+ * The standard set of environment properties for readers in this project.
+ */
+export type EnvMap<E extends keyof EntityMap = never, AE extends keyof EntityMap = never, CE extends keyof ChildEntityMap = never> = {
+    format: Format;
+    formatNumber: FormatNumber;
+    translate: Translate;
+    translateMap: TranslateMap;
+    localeJoin: LocaleJoin;
+    localeCompare: LocaleCompare;
+    responsiveTextSize: ResponsiveTextSize;
+    speed: Speed;
+    energyUnit: EnergyUnit;
+    nonModifiableSuffix?: (param: ModifiableParameter) => TranslationKeysWithoutParams;
+    getInstanceById: GetInstanceById<E>;
+    getAllInstances: GetAllInstances<AE>;
+    getChildInstancesForInstanceId: GetAllChildInstancesForParent<CE>;
+    getResolvedSelectOptionById: GetResolvedSelectOptionById;
+    publicationOptions: PublicationOptions;
+    displayedInProfession: boolean;
+};
+/**
+ * Shortcuts for selecting keys of the shared environment map type.
+ */
+export type EnvMapAbbr = {
+    f: "format";
+    fn: "formatNumber";
+    t: "translate";
+    tm: "translateMap";
+    lj: "localeJoin";
+    lc: "localeCompare";
+    rts: "responsiveTextSize";
+    s: "speed";
+    eu: "energyUnit";
+    nms: "nonModifiableSuffix";
+    ibi: "getInstanceById";
+    ai: "getAllInstances";
+    acibp: "getChildInstancesForInstanceId";
+    rso: "getResolvedSelectOptionById";
+    po: "publicationOptions";
+    dip: "displayedInProfession";
+};
+/**
+ * The standard set of environment properties for readers in this project.
+ *
+ * The keys are abbreviated to keep type annotations short.
+ */
+export type StdEnv<K extends keyof EnvMapAbbr = keyof EnvMapAbbr, E extends keyof EntityMap = never, AE extends keyof EntityMap = never, CE extends keyof ChildEntityMap = never> = Pick<EnvMap<E, AE, CE>, EnvMapAbbr[K]>;
+/**
+ * Shortcut for a reader with common environment properties.
+ *
+ * The keys are abbreviated to keep return type annotations short.
+ */
+export type StdReader<T, K extends keyof EnvMapAbbr, E extends keyof EntityMap = never, AE extends keyof EntityMap = never, CE extends keyof ChildEntityMap = never, EX = AnyNonNullish> = Reader<StdEnv<K, E, AE, CE> & EX, T>;

package/lib/env.js

@@ -0,0 +1 @@
+export {};

package/lib/references/publicationOptions.d.ts

@@ -1,5 +1,5 @@
 import type { Publication, Publication_ID, PublicationRefs } from "@optolith/database-schema/gen";
-import type { StdReader } from "../entities/partial/reader.js";
+import type { StdReader } from "../env.js";
 import type { GetInstanceById } from "../helpers/getTypes.js";
 import type { TranslateMap } from "../helpers/translate.js";
 /**