@optolith/entity-descriptions 0.3.1 → 0.3.2

package/lib/entities/partial/prerequisites/index.js

@@ -170,7 +170,7 @@ export const printLiturgyPrerequisites = (locale, value) => printPlainPrerequisi
 /**
  * Print influence prerequisites as a string.
  */
-export const printInfluencePrerequisites = (getInstanceById, locale, value) => printPlainPrerequisites(prerequisite => printInfluencePrerequisiteGroup(getInstanceById, locale, prerequisite), locale, value);
+export const printInfluencePrerequisites = (getInstanceById, getResolvedSelectOptionById, getChildInstancesForInstanceId, locale, value) => printPlainPrerequisites(prerequisite => printInfluencePrerequisiteGroup(getInstanceById, getResolvedSelectOptionById, getChildInstancesForInstanceId, locale, prerequisite), locale, value);
 /**
  * Print language prerequisites as a string.
  */

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

@@ -1,5 +1,5 @@
 import { AdvantageDisadvantagePrerequisiteGroup, AnimistPowerPrerequisiteGroup, ArcaneTraditionPrerequisiteGroup, DerivedCharacteristicPrerequisiteGroup, EnhancementPrerequisiteGroup, GeneralPrerequisiteGroup, GeodeRitualPrerequisiteGroup, InfluencePrerequisiteGroup, LanguagePrerequisiteGroup, LiturgyPrerequisiteGroup, PersonalityTraitPrerequisiteGroup, PreconditionGroup, ProfessionPrerequisiteGroup, PublicationPrerequisiteGroup, SpellworkPrerequisiteGroup, type ActivatableIdentifier, type RatedIdentifier } from "optolith-database-schema/gen";
-import type { GetInstanceById } from "../../../helpers/getTypes.js";
+import type { GetAllChildInstancesForParent, GetInstanceById } from "../../../helpers/getTypes.js";
 import { LocaleEnvironment } from "../../../helpers/locale.js";
 import { PrerequisitePart } from "./part.js";
 import { GetResolvedSelectOptionById } from "./single/activatable.js";
@@ -42,7 +42,7 @@ export declare const printLiturgyPrerequisiteGroup: (locale: LocaleEnvironment,
 /**
  * Print the translation of an influence prerequisite group.
  */
-export declare const printInfluencePrerequisiteGroup: (getInstanceById: GetInstanceById<"Influence">, locale: LocaleEnvironment, prerequisite: InfluencePrerequisiteGroup) => PrerequisitePart | undefined;
+export declare const printInfluencePrerequisiteGroup: (getInstanceById: GetInstanceById<"Influence" | "Race" | ActivatableIdentifier["kind"] | "Aspect">, getResolvedSelectOptionById: GetResolvedSelectOptionById, getChildInstancesForInstanceId: GetAllChildInstancesForParent<"ProfessionVersion">, locale: LocaleEnvironment, prerequisite: InfluencePrerequisiteGroup) => PrerequisitePart | undefined;
 /**
  * Print the translation of a language prerequisite group.
  */
@@ -58,7 +58,7 @@ export declare const printGeodeRitualPrerequisiteGroup: (getInstanceById: GetIns
 /**
  * Print the translation of an enhancement prerequisite group.
  */
-export declare const printEnhancementPrerequisiteGroup: (getInstanceById: GetInstanceById<RatedIdentifier["kind"] | "Enhancement">, locale: LocaleEnvironment, prerequisite: EnhancementPrerequisiteGroup) => PrerequisitePart | undefined;
+export declare const printEnhancementPrerequisiteGroup: (getInstanceById: GetInstanceById<RatedIdentifier["kind"] | "Enhancement">, locale: Pick<LocaleEnvironment, "translate" | "translateMap">, prerequisite: EnhancementPrerequisiteGroup) => PrerequisitePart | undefined;
 /**
  * Print the translation of a precondition group.
  */

package/lib/entities/partial/prerequisites/prerequisiteGroups.js

@@ -11,6 +11,7 @@ import { printNoOtherAncestorBloodAdvantagePrerequisite } from "./single/noOther
 import { printPactPrerequisite } from "./single/pact.js";
 import { printPersonalityTraitPrerequisite } from "./single/personalityTrait.js";
 import { printPrimaryAttributePrerequisite } from "./single/primaryAttribute.js";
+import { printProfessionPrerequisite } from "./single/profession.js";
 import { printPublicationPrerequisite } from "./single/publication.js";
 import { printRacePrerequisite } from "./single/race.js";
 import { printRatedPrerequisite } from "./single/rated.js";
@@ -196,10 +197,16 @@ printRulePrerequisite(locale, prerequisite.Rule);
 /**
  * Print the translation of an influence prerequisite group.
  */
-export const printInfluencePrerequisiteGroup = (getInstanceById, locale, prerequisite) => {
+export const printInfluencePrerequisiteGroup = (getInstanceById, getResolvedSelectOptionById, getChildInstancesForInstanceId, locale, prerequisite) => {
     switch (prerequisite.kind) {
         case "Influence":
             return printInfluencePrerequisite(getInstanceById, locale, prerequisite.Influence);
+        case "Race":
+            return printRacePrerequisite(getInstanceById, locale, prerequisite.Race);
+        case "Profession":
+            return printProfessionPrerequisite(getChildInstancesForInstanceId, locale, prerequisite.Profession);
+        case "Activatable":
+            return printActivatablePrerequisite(getInstanceById, getResolvedSelectOptionById, locale, prerequisite.Activatable, false);
         case "Text":
             return printTextPrerequisite(locale, prerequisite.Text);
         default:
@@ -261,6 +268,8 @@ export const printPreconditionGroup = (getInstanceById, locale, prerequisite) =>
     switch (prerequisite.kind) {
         case "Publication":
             return printPublicationPrerequisite(getInstanceById, locale, prerequisite.Publication);
+        case "Rule":
+            return printRulePrerequisite(locale, prerequisite.Rule);
         case "SexualCharacteristic":
             return printSexualCharacteristicPrerequisite(locale, prerequisite.SexualCharacteristic);
         default:

package/lib/entities/partial/prerequisites/single/enhancement.d.ts

@@ -5,4 +5,4 @@ import { PrerequisitePart } from "../part.js";
 /**
  * Get the translation of an external enhancement prerequisite.
  */
-export declare const printEnhancementPrerequisite: (getInstanceById: GetInstanceById<"Spell" | "Ritual" | "LiturgicalChant" | "Ceremony" | "Enhancement">, locale: LocaleEnvironment, prerequisite: EnhancementPrerequisite) => PrerequisitePart | undefined;
+export declare const printEnhancementPrerequisite: (getInstanceById: GetInstanceById<"Spell" | "Ritual" | "LiturgicalChant" | "Ceremony" | "Enhancement">, locale: Pick<LocaleEnvironment, "translate" | "translateMap">, prerequisite: EnhancementPrerequisite) => PrerequisitePart | undefined;

package/lib/entities/partial/prerequisites/single/profession.d.ts

@@ -0,0 +1,8 @@
+import { type ProfessionPrerequisite } from "optolith-database-schema/gen";
+import { type GetAllChildInstancesForParent } from "../../../../helpers/getTypes.js";
+import { LocaleEnvironment } from "../../../../helpers/locale.js";
+import { PrerequisitePart } from "../part.js";
+/**
+ * Get the translation of a profession prerequisite.
+ */
+export declare const printProfessionPrerequisite: (getChildInstancesForInstanceId: GetAllChildInstancesForParent<"ProfessionVersion">, locale: Pick<LocaleEnvironment, "translateMap">, prerequisite: ProfessionPrerequisite) => PrerequisitePart | undefined;

package/lib/entities/partial/prerequisites/single/profession.js

@@ -0,0 +1,19 @@
+import { getProfessionName } from "../../professions.js";
+import { printDisplayOption } from "../displayOption.js";
+/**
+ * Get the translation of a profession prerequisite.
+ */
+export const printProfessionPrerequisite = (getChildInstancesForInstanceId, locale, prerequisite) => {
+    if (prerequisite.displayOption !== undefined) {
+        return printDisplayOption(locale.translateMap, prerequisite.displayOption);
+    }
+    const professionName = getProfessionName(locale.translateMap, getChildInstancesForInstanceId, prerequisite.id);
+    if (professionName === undefined) {
+        return undefined;
+    }
+    return {
+        value: professionName,
+        sentenceType: undefined,
+        isMeta: false,
+    };
+};

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

@@ -1,4 +1,3 @@
-import { type RangeBounds } from "@elyukai/utils/range";
 import type { ImprovementCost } from "optolith-database-schema/gen";
 import { type RawDefinitionListEntityDescriptionSectionItem } from "../../../index.js";
 import { type StdReader } from "../reader.js";
@@ -10,10 +9,3 @@ export declare const renderImprovementCostValue: (improvementCost: ImprovementCo
  * Returns the improvement cost as an inline library property.
  */
 export declare const renderImprovementCost: (improvementCost: ImprovementCost) => StdReader<RawDefinitionListEntityDescriptionSectionItem, "t">;
-/**
- * Calculates the adventure points for an improvement cost.
- * @throws {RangeError} if the rating range is invalid (max < min).
- */
-export declare const calculateAdventurePointsFromImprovementCost: (improvementCost: ImprovementCost | ImprovementCost["kind"] | {
-    kind: "E";
-} | "E", rating?: number | RangeBounds) => number;

package/lib/entities/partial/rated/improvementCost.js

@@ -1,5 +1,3 @@
-import { rangeSize } from "@elyukai/utils/range";
-import { assertExhaustive } from "@elyukai/utils/typeSafety";
 import { translateR } from "../reader.js";
 /**
  * Renders an improvement cost value as a string.
@@ -12,55 +10,3 @@ export const renderImprovementCost = (improvementCost) => translateR("Improvemen
     label,
     value: renderImprovementCostValue(improvementCost),
 }));
-/**
- * Calculates the adventure points for an improvement cost.
- * @throws {RangeError} if the rating range is invalid (max < min).
- */
-export const calculateAdventurePointsFromImprovementCost = (improvementCost, rating = 1) => {
-    const normalized = typeof improvementCost === "string" ? improvementCost : improvementCost.kind;
-    const base = (() => {
-        switch (normalized) {
-            case "A":
-                return 1;
-            case "B":
-                return 2;
-            case "C":
-                return 3;
-            case "D":
-                return 4;
-            case "E":
-                return 15;
-            default:
-                return assertExhaustive(normalized);
-        }
-    })();
-    const lastRatingOfSameValue = (() => {
-        switch (normalized) {
-            case "A":
-            case "B":
-            case "C":
-            case "D":
-                return 12;
-            case "E":
-                return 14;
-            default:
-                return assertExhaustive(normalized);
-        }
-    })();
-    if (typeof rating === "number") {
-        return (base *
-            (rating < lastRatingOfSameValue ? 1 : rating - lastRatingOfSameValue + 1));
-    }
-    else {
-        const [min, max] = rating;
-        if (max < min) {
-            throw new RangeError(`Invalid rating range: ${min} - ${max}`);
-        }
-        const size = rangeSize(rating);
-        const constantRangeSize = Math.min(size, lastRatingOfSameValue - min + 1);
-        const variableRangeSize = size - constantRangeSize;
-        const constantCost = base * constantRangeSize;
-        const variableCost = base * (((variableRangeSize + 1) * (variableRangeSize + 2)) / 2 - 1);
-        return constantCost + variableCost;
-    }
-};

package/lib/entities/poison.js

@@ -28,18 +28,14 @@ const renderApplicationType = (translate, localeJoin, localeCompare, application
         }
     })
         .toSorted(localeCompare)
-        .map((type, index, arr) => index === arr.length - 1 && type.at(-1) === "-"
-        ? type.slice(0, -1)
-        : type), "conjunction"),
+        .map((type, index, arr) => index === arr.length - 1 && type.at(-1) === "-" ? type.slice(0, -1) : type), "conjunction"),
 });
 const renderLevel = (translate, translateMap, level) => {
     switch (level.kind) {
         case "QualityLevel":
             return translate("QL");
         case "Constant":
-            return typeof level.Constant === "number"
-                ? level.Constant
-                : level.Constant.value;
+            return typeof level.Constant === "number" ? level.Constant : level.Constant.value;
         case "BySubtype":
             return level.BySubtype.map(subtype => `${subtype.value} (${translateMap(subtype.translations)?.name ?? MISSING_VALUE})`).join(", ");
         default:
@@ -84,9 +80,7 @@ const renderIntoxicantValues = (translate, translateMap, getInstanceById, intoxi
         ingestion: translation?.ingestion ?? MISSING_VALUE,
         sideEffect: translation?.side_effect,
         overdose: translation?.overdose ?? MISSING_VALUE,
-        legality: intoxicant.legality.is_legal
-            ? translate("legal")
-            : translate("illegal"),
+        legality: intoxicant.legality.is_legal ? translate("legal") : translate("illegal"),
         special: translation?.special,
         addiction: intoxicant?.addiction === undefined
             ? undefined
@@ -104,13 +98,20 @@ const renderSourceTypeBasedValues = (translate, translateMap, getInstanceById, s
             const translation = translateMap(sourceType.AlchemicalPoison.translations);
             return {
                 level: translate("QL"),
-                sourceType: translate("alchemical poison"),
+                sourceType: [
+                    sourceType.AlchemicalPoison.isDemonic === true ? translate("demonic poison") : undefined,
+                    translate("alchemical poison"),
+                ]
+                    .filter(isNotNullish)
+                    .join(", "),
                 ...(sourceType.AlchemicalPoison.intoxicant === undefined
                     ? undefined
                     : renderIntoxicantValues(translate, translateMap, getInstanceById, sourceType.AlchemicalPoison.intoxicant)),
                 typicalIngredients: translation?.typical_ingredients.join(", "),
                 priceOfIngedientsPerLevel: translate("{$cost} per level", {
-                    cost: translate(".input {$value :number} {{{$value} silverthalers}}", { value: sourceType.AlchemicalPoison.cost_per_ingredient_level }),
+                    cost: translate(".input {$value :number} {{{$value} silverthalers}}", {
+                        value: sourceType.AlchemicalPoison.cost_per_ingredient_level,
+                    }),
                 }),
                 laboratory: renderLaboratoryLevel(translate, sourceType.AlchemicalPoison.laboratory),
                 brewingDifficulty: sign(sourceType.AlchemicalPoison.brewing_difficulty),
@@ -121,6 +122,11 @@ const renderSourceTypeBasedValues = (translate, translateMap, getInstanceById, s
                 })),
             };
         }
+        case "AlchemicalPactGiftPoison":
+            return {
+                level: translate("QL"),
+                sourceType: translate("alchemical poison"),
+            };
         case "MineralPoison":
             return {
                 level: sourceType.MineralPoison.level,
@@ -155,8 +161,7 @@ const renderStart = (translate, translateMap, start) => {
         case "DiceBased":
             return formatTimeSpan(translate, ResponsiveTextSize.Full, start.DiceBased.unit, renderDiceAndFlat(translate, start.DiceBased.dice, start.DiceBased.flat));
         case "Indefinite":
-            return (translateMap(start.Indefinite.translations)?.description ??
-                MISSING_VALUE);
+            return translateMap(start.Indefinite.translations)?.description ?? MISSING_VALUE;
         default:
             return assertExhaustive(start);
     }
@@ -176,13 +181,14 @@ const renderDuration = (translate, translateMap, duration) => {
                         return value.Constant.toString();
                     case "Dice":
                         return renderDice(translate, value.Dice);
+                    case "CircleOfDamnation":
+                        return translate("CoD");
                     default:
                         return assertExhaustive(value);
                 }
             });
         case "Indefinite":
-            return (translateMap(duration.Indefinite.translations)?.description ??
-                UNHANDLED_VALUE);
+            return translateMap(duration.Indefinite.translations)?.description ?? UNHANDLED_VALUE;
         default:
             return assertExhaustive(duration);
     }
@@ -197,8 +203,14 @@ const renderCost = (translate, translateMap, cost) => {
             return translate(".input {$value :number} {{{$value} silverthalers}}", {
                 value: cost.Constant,
             });
+        case "DependingOnPurchaseOrSale":
+            return `${translate(".input {$value :number} {{{$value} silverthalers}}", {
+                value: cost.DependingOnPurchaseOrSale.purchase,
+            })} (${translate("purchase")}) / ${translate(".input {$value :number} {{{$value} silverthalers}}", {
+                value: cost.DependingOnPurchaseOrSale.sale,
+            })} (${translate("sale")})`;
         case "Indefinite":
-            return (translateMap(cost.Indefinite.translations)?.description ?? MISSING_VALUE);
+            return translateMap(cost.Indefinite.translations)?.description ?? MISSING_VALUE;
         default:
             return assertExhaustive(cost);
     }
@@ -218,7 +230,7 @@ const renderValueCost = (translate, translateMap, cost, value) => value === unde
  * Get a JSON representation of the rules text for a poison.
  */
 export const getPoisonEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getResolvedSelectOptionById, idMap }, locale, { content: entry }) => {
-    const { translate, translateMap, join: localeJoin, compare: localeCompare, } = locale;
+    const { translate, translateMap, join: localeJoin, compare: localeCompare } = locale;
     const translation = translateMap(entry.translations);
     if (translation === undefined) {
         return undefined;
@@ -254,9 +266,7 @@ export const getPoisonEntityDescription = createEntityDescriptionCreator(({ getI
                     {
                         label: translate("Effect"),
                         value: translation.effect.default +
-                            (translation.effect.reduced === undefined
-                                ? ""
-                                : ` / ${translation.effect.reduced}`),
+                            (translation.effect.reduced === undefined ? "" : ` / ${translation.effect.reduced}`),
                     },
                     sideEffect === undefined
                         ? undefined
@@ -287,7 +297,9 @@ export const getPoisonEntityDescription = createEntityDescriptionCreator(({ getI
                             label: translate("Legality"),
                             value: legality,
                         },
-                    renderValueCost(translate, translateMap, entry.cost, entry.value),
+                    entry.cost === undefined
+                        ? undefined
+                        : renderValueCost(translate, translateMap, entry.cost, entry.value),
                     special === undefined
                         ? undefined
                         : {

package/lib/entities/spell.d.ts

@@ -1,3 +1,4 @@
+import { type RatedIdentifier } from "optolith-database-schema/gen";
 import type { GetAllChildInstancesForParent, GetInstanceById } from "../helpers/getTypes.js";
 import { type IdMap } from "../index.js";
 /**
@@ -10,14 +11,16 @@ export declare const getCantripEntityDescription: import("../creator.js").Entity
  * Get a JSON representation of the rules text for a skill.
  */
 export declare const getSpellEntityDescription: import("../creator.js").EntityDescriptionCreator<"Spell", {
-    getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic">;
+    getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic" | RatedIdentifier["kind"] | "Enhancement">;
+    getChildInstancesForInstanceId: GetAllChildInstancesForParent<"Enhancement">;
     idMap: IdMap;
 }, import("../index.js").EntityDescription>;
 /**
  * Get a JSON representation of the rules text for a ritual.
  */
 export declare const getRitualEntityDescription: import("../creator.js").EntityDescriptionCreator<"Ritual", {
-    getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic">;
+    getInstanceById: GetInstanceById<"Publication" | "Attribute" | "SkillModificationLevel" | "TargetCategory" | "Property" | "MagicalTradition" | "DerivedCharacteristic" | RatedIdentifier["kind"] | "Enhancement">;
+    getChildInstancesForInstanceId: GetAllChildInstancesForParent<"Enhancement">;
     idMap: IdMap;
 }, import("../index.js").EntityDescription>;
 /**

package/lib/entities/spell.js

@@ -10,6 +10,7 @@ import { assertExhaustive } from "@optolith/helpers/typeSafety";
 import { Case } from "tsondb/schema/gen";
 import { createEntityDescriptionCreator } from "../creator.js";
 import { renderAnimalTypesSection } from "./partial/animalTypes.js";
+import { renderEnhancements } from "./partial/enhancements.js";
 import { printAnimistPowerPrerequisites, printGeodeRitualPrerequisites, } from "./partial/prerequisites/index.js";
 import { renderCastingTime, renderFastSkillNonModifiableCastingTime, renderSlowSkillNonModifiableCastingTime, } from "./partial/rated/activatable/castingTime.js";
 import { renderMagicalActionCost, renderModifiableOneTimeCost, renderNonModifiableOneTimeCost, } from "./partial/rated/activatable/cost.js";
@@ -151,7 +152,7 @@ export const getCantripEntityDescription = createEntityDescriptionCreator(({ get
 /**
  * Get a JSON representation of the rules text for a skill.
  */
-export const getSpellEntityDescription = createEntityDescriptionCreator(({ getInstanceById, idMap }, locale, { content: entry }) => {
+export const getSpellEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }) => {
     const { translate, translateMap, compare: localeCompare } = locale;
     const translation = translateMap(entry.translations);
     if (translation === undefined) {
@@ -161,7 +162,9 @@ export const getSpellEntityDescription = createEntityDescriptionCreator(({ getIn
         translate,
         translateMap,
         getInstanceById,
+        getChildInstancesForInstanceId,
         localeJoin: locale.join,
+        localeCompare: locale.compare,
         energyUnit: "ArcaneEnergy",
         responsiveTextSize: ResponsiveTextSize.Full,
         nonModifiableSuffix: (param) => {
@@ -197,6 +200,7 @@ export const getSpellEntityDescription = createEntityDescriptionCreator(({ getIn
                     renderImprovementCost(entry.improvement_cost).run(env),
                 ],
             },
+            renderEnhancements(Case(entity, id), entry.improvement_cost).run(env),
         ],
         errata: translation.errata,
         references: entry.src,
@@ -205,7 +209,7 @@ export const getSpellEntityDescription = createEntityDescriptionCreator(({ getIn
 /**
  * Get a JSON representation of the rules text for a ritual.
  */
-export const getRitualEntityDescription = createEntityDescriptionCreator(({ getInstanceById, idMap }, locale, { content: entry }) => {
+export const getRitualEntityDescription = createEntityDescriptionCreator(({ getInstanceById, getChildInstancesForInstanceId, idMap }, locale, { content: entry, entity, id }) => {
     const { translate, translateMap, compare: localeCompare } = locale;
     const translation = translateMap(entry.translations);
     if (translation === undefined) {
@@ -215,7 +219,9 @@ export const getRitualEntityDescription = createEntityDescriptionCreator(({ getI
         translate,
         translateMap,
         getInstanceById,
+        getChildInstancesForInstanceId,
         localeJoin: locale.join,
+        localeCompare: locale.compare,
         energyUnit: "ArcaneEnergy",
         responsiveTextSize: ResponsiveTextSize.Full,
         nonModifiableSuffix: (param) => {
@@ -251,6 +257,7 @@ export const getRitualEntityDescription = createEntityDescriptionCreator(({ getI
                     renderImprovementCost(entry.improvement_cost).run(env),
                 ],
             },
+            renderEnhancements(Case(entity, id), entry.improvement_cost).run(env),
         ],
         errata: translation.errata,
         references: entry.src,