@optolith/entity-descriptions 0.4.0 → 0.4.2

package/lib/entities/profession.d.ts

@@ -1,4 +1,4 @@
-import { type MagicalActionIdentifier, type RatedIdentifier, type SpecialAbilityIdentifier } from "optolith-database-schema/gen";
+import type { MagicalActionIdentifier, RatedIdentifier, SpecialAbilityIdentifier } from "optolith-database-schema/gen";
 import type { GetAllChildInstancesForParent, GetAllInstances, GetInstanceById } from "../helpers/getTypes.js";
 import { type GetResolvedSelectOptionById } from "./partial/prerequisites/single/activatable.js";
 /**

package/lib/entities/profession.js

@@ -24,6 +24,7 @@ const renderNumericListAcrossPackages = (packages, selector, equalityFn, renderT
     .reduce((accR, pkg, pkgIndex) => accR.map2(selector(pkg), (acc, selected) => selected.reduce((filledAcc, [values, number]) => {
     const existing = filledAcc.findIndex(([value]) => equalityFn(value, values));
     if (existing >= 0) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- existing is checked to be >= 0
         filledAcc[existing][1][pkgIndex] = number + defaultValue;
         return filledAcc;
     }
@@ -32,9 +33,7 @@ const renderNumericListAcrossPackages = (packages, selector, equalityFn, renderT
             ...filledAcc,
             [
                 values,
-                Array(pkgIndex)
-                    .fill(defaultValue)
-                    .concat(number + defaultValue),
+                Array.from({ length: pkgIndex }, () => defaultValue).concat(number + defaultValue),
             ],
         ];
     }
@@ -117,12 +116,11 @@ const getTotalingAPValues = (professionPackages, selector) => {
         return undefined;
     }
     return allSame(options, deepEqual)
-        ? options[0].ap_value
+        ? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- not all are nullish and because all are the same, none is nullish
+            options[0].ap_value
         : options.map(option => option?.ap_value ?? 0).join("/");
 };
-const renderSkillsOption = (professionPackages, skillGroup) => mapNullable(getTotalingAPValues(professionPackages, pkg => pkg.content.options?.skills?.group === skillGroup.id
-    ? pkg.content.options?.skills
-    : undefined), apValue => translateR("{$apValue} AP to improve other {$skillsOfGroup}", {
+const renderSkillsOption = (professionPackages, skillGroup) => mapNullable(getTotalingAPValues(professionPackages, pkg => pkg.content.options?.skills?.group === skillGroup.id ? pkg.content.options.skills : undefined), apValue => translateR("{$apValue} AP to improve other {$skillsOfGroup}", {
     apValue,
     skillsOfGroup: skillGroup.nameOfSkillsOfGroup,
 })) ?? Reader.of(undefined);
@@ -171,6 +169,7 @@ const renderCantripsOption = (professionPackages) => {
         return Reader.of(undefined);
     }
     if (allSame(cantripsOptions, deepEqual)) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- not all are nullish and because all are the same, none is nullish
         return renderSingleCantripsOption(cantripsOptions[0]);
     }
     else {
@@ -245,7 +244,7 @@ const renderVariantSkillsOption = (baseOptions, variantOptions) => renderVariant
         apValue: override.ap_value,
         skillsOfGroup: nameOfSkillsOfGroup,
     })),
-    update: (base, override) => plainOrInsteadOfR(base, override, b => b.ap_value, equal, Reader.of).thenW(apValue => plainOrInsteadOfR(base, override, b => b.group, equal, nameOfSkillsOfGroupR).thenW(nameOfSkillsOfGroup => translateR("{$apValue} AP to improve other {$skillsOfGroup}", {
+    update: (base, override) => plainOrInsteadOfR(base, override, b => b.ap_value, equal, b => Reader.of(b)).thenW(apValue => plainOrInsteadOfR(base, override, b => b.group, equal, nameOfSkillsOfGroupR).thenW(nameOfSkillsOfGroup => translateR("{$apValue} AP to improve other {$skillsOfGroup}", {
         apValue,
         skillsOfGroup: nameOfSkillsOfGroup,
     }))),
@@ -389,10 +388,11 @@ const renderBlessings = (professionPackages) => {
         return Reader.of(undefined);
     }
     else if (allSame(traditions, deepEqual)) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- not all are empty and because all are the same, none is empty
         return renderSingleBlessings(traditions[0]);
     }
     else {
-        return Reader.traverse(traditions, option => option === undefined ? Reader.of("—") : renderSingleBlessings(option)).map(list => list.join(" / "));
+        return Reader.traverse(traditions, option => option.length === 0 ? Reader.of("—") : renderSingleBlessings(option)).map(list => list.join(" / "));
     }
 };
 const renderLiturgicalChantName = (liturgyIds) => Reader.traverse(liturgyIds, strictNameR).thenW(list => localeJoinR(list, "disjunction"));
@@ -404,7 +404,7 @@ const renderLiturgicalChants = (professionPackages) => Reader.sequence([
 const renderRatedVariantChanges = (baseList, variantList, renderInstance) => Reader.traverse(variantList ?? [], ({ id, rating_modifier }) => {
     const baseValue = baseList?.find(item => deepEqual(item.id, id))?.rating_modifier ?? 0;
     return renderInstance(id).thenW(name => translateR("{$replacement} instead of {$base}", {
-        replacement: `${name} ${baseValue + rating_modifier}`,
+        replacement: `${name} ${(baseValue + rating_modifier).toFixed()}`,
         base: baseValue,
     }));
 }).thenW(localeSortR);
@@ -495,9 +495,14 @@ export const getProfessionVersionEntityDescription = createEntityDescriptionCrea
     }
     return {
         title: translation.name.default +
-            (professionPackages.length > 1
-                ? ` (${professionPackages.map(pkg => translateMap(pkg.experienceLevel.translations)?.name).join("/")})`
-                : ""),
+            parensIf(ensureNonEmpty([
+                translation.specification?.default,
+                professionPackages.length > 1
+                    ? professionPackages
+                        .map(pkg => translateMap(pkg.experienceLevel.translations)?.name)
+                        .join("/")
+                    : undefined,
+            ].filter(isNotNullish))?.join(", ")),
         className: "profession",
         body: [
             {
@@ -529,7 +534,7 @@ export const getProfessionVersionEntityDescription = createEntityDescriptionCrea
                             curses: pkg.content.options?.curses,
                             list: pkg.content.special_abilities,
                         }), deepEqual, specialAbilityLists => Reader.of(specialAbilityLists
-                            .map(specialAbilities => specialAbilities === undefined
+                            .map(specialAbilities => Object.values(specialAbilities).every(list => list === undefined)
                             ? translate("none")
                             : renderSpecialAbilities(specialAbilities).run(env))
                             .join(" / "))).run(env),

package/lib/entities/race.js

@@ -10,11 +10,10 @@ import { renderCommonnessRatedAdvantagesAndDisadvantages, renderCommonnessRatedA
 import { MISSING_VALUE } from "./partial/unknown.js";
 const renderBaseValueItem = (label, value) => Reader.asks(({ translate }) => ({
     label: translate(label),
-    value: value < 0 ? sign(value) : value.toString(),
+    value: value < 0 ? sign(value) : value.toFixed(),
 }));
 const renderAttributeAdjustmentsItem = (totalAttributesCount, adjustments) => Reader.asks(({ translate, translateMap, localeJoin, getInstanceById, }) => {
-    const getAttributeAbbreviation = (id) => translateMap(getInstanceById("Attribute", id)?.translations)
-        ?.abbreviation ?? MISSING_VALUE;
+    const getAttributeAbbreviation = (id) => translateMap(getInstanceById("Attribute", id)?.translations)?.abbreviation ?? MISSING_VALUE;
     return {
         label: translate("Attribute Adjustments"),
         value: [
@@ -35,7 +34,9 @@ const renderVariantValues = (label, variants, selector, renderValue, translation
         };
     });
     const sameValues = anySameIndices(values, on(value => [value.value, value.valueTranslation], deepEqual));
-    if (sameValues.length === 1 && sameValues[0].length === values.length) {
+    if (isNotEmpty(sameValues) &&
+        sameValues.length === 1 &&
+        sameValues[0].length === values.length) {
         return {
             label: translate(label),
             value: values[0] === undefined
@@ -50,9 +51,7 @@ const renderVariantValues = (label, variants, selector, renderValue, translation
                 {
                     type: "definitionList",
                     style: "nested",
-                    items: Map.groupBy(values
-                        .toSorted(on(item => item.name, localeCompare))
-                        .map(value => ({
+                    items: Map.groupBy(values.toSorted(on(item => item.name, localeCompare)).map(value => ({
                         label: value.name,
                         value: value.valueTranslation ?? renderValue(value.value),
                     })), item => item.value)
@@ -72,17 +71,14 @@ const renderAutomaticAdvantagesOrDisadvantages = (entity, items) => Reader.asks(
     : items
         .map(item => {
         const instanceTranslation = translateMap(getInstanceById(entity, item.id)?.translations);
-        return (instanceTranslation?.name_in_library ??
-            instanceTranslation?.name ??
-            MISSING_VALUE);
+        return (instanceTranslation?.name_in_library ?? instanceTranslation?.name ?? MISSING_VALUE);
     })
         .toSorted(localeCompare)
         .join(", "));
 const renderCommonCultures = (items) => Reader.asks(({ translate, translateMap, getInstanceById, localeCompare }) => items === undefined || !isNotEmpty(items)
     ? translate("none")
     : items
-        .map(itemId => translateMap(getInstanceById("Culture", itemId)?.translations)
-        ?.name)
+        .map(itemId => translateMap(getInstanceById("Culture", itemId)?.translations)?.name)
         .filter(isNotNullish)
         .toSorted(localeCompare)
         .join(", "));
@@ -112,7 +108,9 @@ export const getRaceEntityDescription = createEntityDescriptionCreator(({ getIns
                 items: [
                     {
                         label: translate("AP Value"),
-                        value: translate(".input {$value :number} {{{$value} Adventure Points}}", { value: entry.ap_value }),
+                        value: translate(".input {$value :number} {{{$value} Adventure Points}}", {
+                            value: entry.ap_value,
+                        }),
                     },
                     renderBaseValueItem("Life Point Base Value", entry.base_values.life_points).run(env),
                     renderBaseValueItem("Spirit Base Value", entry.base_values.spirit).run(env),

package/lib/entities/sexPractice.js

@@ -22,9 +22,7 @@ export const getSexPracticeEntityDescription = createEntityDescriptionCreator((_
                             label: translate("Prerequisites"),
                             value: translation.prerequisites,
                         },
-                    translation.failed === undefined
-                        ? undefined
-                        : { label: translate("Failed"), value: translation.failed },
+                    { label: translate("Failed"), value: translation.failed },
                 ],
             },
         ],

package/lib/entities/skill.js

@@ -109,10 +109,9 @@ export const getSkillEntityDescription = createEntityDescriptionCreator(({ getIn
                             ? translate("Yes")
                             : entry.encumbrance.kind === "No"
                                 ? translate("No")
-                                : (translation.encumbrance_description ??
-                                    translate("Maybe")),
+                                : (translation.encumbrance_description ?? translate("Maybe")),
                     },
-                    translation?.tools === undefined
+                    translation.tools === undefined
                         ? undefined
                         : {
                             label: translate("Tools"),

package/lib/entities/spell.js

@@ -16,7 +16,7 @@ import { renderCastingTime, renderFastSkillNonModifiableCastingTime, renderSlowS
 import { renderMagicalActionCost, renderModifiableOneTimeCost, renderNonModifiableOneTimeCost, } from "./partial/rated/activatable/cost.js";
 import { renderCheckResultBasedDuration, renderMusicDuration, renderOneTimeDuration, renderSustainedDuration, } from "./partial/rated/activatable/duration.js";
 import { renderEffect } from "./partial/rated/activatable/effect.js";
-import { renderFastPerformanceParameters, renderSlowOneTimePerformanceParameters, renderSlowPerformanceParameters, } from "./partial/rated/activatable/index.js";
+import { combineGeneratedTextWithStaticTranslation, renderFastPerformanceParameters, renderSlowOneTimePerformanceParameters, renderSlowPerformanceParameters, } from "./partial/rated/activatable/index.js";
 import { ModifiableParameter } from "./partial/rated/activatable/nonModifiableSuffix.js";
 import { parensIf } from "./partial/rated/activatable/parensIf.js";
 import { renderNonModifiableRange } from "./partial/rated/activatable/range.js";
@@ -28,18 +28,6 @@ import { formatEnergyR, localeJoinR, responsiveR, responsiveTextR, responsiveTra
 import { appendNoteIfNeeded, getResponsiveText, ResponsiveTextSize, } from "./partial/responsiveText.js";
 import { formatTimeSpanR } from "./partial/units/timeSpan.js";
 import { MISSING_VALUE } from "./partial/unknown.js";
-const combineGeneratedTextWithStaticTranslation = (label, generatedText, staticText) => {
-    if (generatedText === undefined) {
-        return undefined;
-    }
-    const normalizedStaticText = typeof staticText === "string" ? staticText : staticText?.full;
-    return {
-        label,
-        value: normalizedStaticText !== undefined && generatedText !== normalizedStaticText
-            ? `***${generatedText}*** (${normalizedStaticText})`
-            : generatedText,
-    };
-};
 const renderProperty = (id) => Reader.asks(({ translate, translateMap, getInstanceById }) => {
     const text = (() => {
         const staticEntry = getInstanceById("Property", id);
@@ -854,7 +842,7 @@ const renderMagicalRuneCost = (options, cost) => {
         case "Disjunction":
             return Reader.sequence(cost.Disjunction.list.map(costItem => formatEnergyR(costItem.value).thenW(text => appendNoteIfNeeded(costItem.translations, text)))).thenW(text => localeJoinR(text, "disjunction"));
         case "DerivedFromOption":
-            return deriveValueGroupsFromMagicalRuneOptions(options, option => option.cost?.value, compareNullish(numAsc), num => num?.toString() ?? MISSING_VALUE).thenW(formatEnergyR);
+            return deriveValueGroupsFromMagicalRuneOptions(options, option => option.cost?.value, compareNullish(numAsc), num => num?.toFixed() ?? MISSING_VALUE).thenW(formatEnergyR);
         default:
             return assertExhaustive(cost);
     }

package/lib/helpers/getTypes.d.ts

@@ -1,5 +1,5 @@
-import * as Database from "optolith-database-schema/gen";
-import { IdArgsVariant } from "tsondb/schema/gen";
+import type * as Database from "optolith-database-schema/gen";
+import type { IdArgsVariant } from "tsondb/schema/gen";
 export type GetInstanceById<in T extends Extract<keyof Database.EntityMap, string>> = <U extends T>(...args: IdArgsVariant<Database.EntityMap, U>) => Database.EntityMap[U] | undefined;
 export type GetAllInstances<T extends keyof Database.EntityMap> = <U extends T>(entity: U) => {
     id: string;

package/lib/helpers/locale.d.ts

@@ -1,6 +1,6 @@
-import { Compare } from "@optolith/helpers/compare";
+import type { Compare } from "@optolith/helpers/compare";
 import type { LocaleMeasurementAdjustments } from "optolith-database-schema/gen";
-import { Translate, TranslateMap, type Format } from "./translate.js";
+import type { Format, Translate, TranslateMap } from "./translate.js";
 /**
  * The type of list to join in a locale-aware way.
  */
@@ -12,6 +12,7 @@ export type LocaleEnvironment = {
     id: string;
     format: Format;
     formatDate: (date: Date) => string;
+    formatNumber: FormatNumber;
     translate: Translate;
     translateMap: TranslateMap;
     compare: LocaleCompare;
@@ -26,3 +27,7 @@ export type LocaleCompare = Compare<string>;
  * A function that joins a list of strings according to the locale's rules for the given type.
  */
 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;

package/lib/helpers/translate.d.ts

@@ -1,4 +1,4 @@
-import { Locale } from "optolith-database-schema/gen";
+import type { Locale } from "optolith-database-schema/gen";
 import { ResponsiveTextSize } from "../entities/partial/responsiveText.js";
 /**
  * The type of all translations

package/lib/index.d.ts

@@ -6,13 +6,14 @@ import type { EntityDescriptionCreator } from "./creator.js";
 import type { GetResolvedSelectOptionById } from "./entities/partial/prerequisites/single/activatable.js";
 import type { CountInstances, GetAllChildInstancesForParent, GetAllInstances, GetInstanceById } from "./helpers/getTypes.js";
 import type { LocaleEnvironment } from "./helpers/locale.js";
-export { LocaleEnvironment };
+export type { LocaleEnvironment };
 /**
  * A JSON representation of the rules text for a library entry.
  */
 export type EntityDescription = {
     title: string;
     subtitle?: string;
+    badge?: number;
     className: string;
     body: EntityDescriptionSection[];
     errata?: {
@@ -44,6 +45,7 @@ export type EntityDescriptionSectionContent<DL = DefinitionListEntityDescription
 export type RawEntityDescription = {
     title: string;
     subtitle?: string;
+    badge?: number;
     className: string;
     body: (RawEntityDescriptionSection | undefined)[];
     errata?: Errata;

package/lib/index.js

@@ -171,6 +171,7 @@ export const supportedEntities = Object.keys(registeredEntityDescriptionCreators
 /**
  * Get a JSON representation of the rules text for an entry in the database.
  */
+// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-parameters -- false positive
 export const getEntityDescription = (database, localeEnv, idMap, getResolvedSelectOptionById, getAllResolvedSelectOptions, getAllResolvedNewSkillApplications, getAllResolvedSkillUses, entityName, instanceId) => {
     const creator = registeredEntityDescriptionCreators[entityName];
     const instance = database.getInstanceOfEntityById(entityName, instanceId);

package/lib/references/index.d.ts

@@ -1,6 +1,6 @@
 import type { PublicationRefs } from "optolith-database-schema/gen";
 import type { GetInstanceById } from "../helpers/getTypes.js";
-import { LocaleEnvironment } from "../helpers/locale.js";
+import type { LocaleEnvironment } from "../helpers/locale.js";
 /**
  * Returns the translation of the references.
  */

package/lib/references/index.js

@@ -1,6 +1,6 @@
 import { isNotNullish } from "@optolith/helpers/nullable";
 import { assertExhaustive } from "@optolith/helpers/typeSafety";
-import { fromRawPageRange, normalizePageRanges, printPageRanges, } from "./pageRange.js";
+import { fromRawPageRange, normalizePageRanges, printPageRanges } from "./pageRange.js";
 /**
  * Returns the translation of the references.
  */

package/lib/references/page.d.ts

@@ -1,6 +1,6 @@
-import { Compare } from "@optolith/helpers/compare";
-import { Page } from "optolith-database-schema/gen";
-import { Translate } from "../helpers/translate.js";
+import type { Compare } from "@optolith/helpers/compare";
+import type { Page } from "optolith-database-schema/gen";
+import type { Translate } from "../helpers/translate.js";
 /**
  * A comparison function for two pages.
  */

package/lib/references/page.js

@@ -54,7 +54,7 @@ export const printPage = (translate, page) => {
         case "InsideCoverBack":
             return translate("Back Cover Inside");
         case "Numbered":
-            return page.Numbered.toString();
+            return page.Numbered.toFixed();
         default:
             return assertExhaustive(page);
     }

package/lib/references/pageRange.d.ts

@@ -1,5 +1,5 @@
-import { Page, PageRange as RawPageRange } from "optolith-database-schema/gen";
-import { Translate } from "../helpers/translate.js";
+import type { Page, PageRange as RawPageRange } from "optolith-database-schema/gen";
+import type { Translate } from "../helpers/translate.js";
 /**
  * A range of pages, including the first and last page, if the range includes
  * more than on page.