@optolith/entity-descriptions 0.1.1 → 0.2.0

package/lib/entities/partial/rated/activatable/index.js

@@ -1,59 +1,41 @@
-import { getTextForFastCastingTime, getTextForSlowCastingTime, } from "./castingTime.js";
-import { getTextForOneTimeCost, getTextForSustainedCost } from "./cost.js";
-import { getTextForDurationForOneTime, getTextForDurationForSustained, } from "./duration.js";
+import { getFastCastingTimeTranslation, getSlowCastingTimeTranslation, } from "./castingTime.js";
+import { getOneTimeCostTranslation, getSustainedCostTranslation, } from "./cost.js";
+import { getDurationForOneTimeTranslation, getDurationForSustainedTranslation, } from "./duration.js";
 import { getTextForActivatableSkillRange } from "./range.js";
 import { Speed } from "./speed.js";
 /**
  * Get the texts for all fast one-time performance parameters.
  */
-export const getTextForFastOneTimePerformanceParameters = (deps, value, env) => ({
-    castingTime: getTextForFastCastingTime(deps, value.casting_time, env),
-    cost: getTextForOneTimeCost(deps, value.cost, { speed: Speed.Fast, ...env }),
-    range: getTextForActivatableSkillRange(deps, value.range, {
-        speed: Speed.Fast,
-        ...env,
-    }),
-    duration: getTextForDurationForOneTime(deps, value.duration, env),
+export const getFastOneTimePerformanceParametersTranslations = (getSkillModificationLevelById, locale, entity, responsiveTextSize, value) => ({
+    castingTime: getFastCastingTimeTranslation(getSkillModificationLevelById, locale, entity, responsiveTextSize, value.casting_time),
+    cost: getOneTimeCostTranslation(getSkillModificationLevelById, locale, Speed.Fast, entity, responsiveTextSize, value.cost),
+    range: getTextForActivatableSkillRange(getSkillModificationLevelById, locale, Speed.Fast, responsiveTextSize, entity, value.range),
+    duration: getDurationForOneTimeTranslation(locale, responsiveTextSize, value.duration),
 });
 /**
  * Get the texts for all fast sustained performance parameters.
  */
-export const getTextForFastSustainedPerformanceParameters = (deps, value, env) => ({
-    castingTime: getTextForFastCastingTime(deps, value.casting_time, env),
-    cost: getTextForSustainedCost(deps, value.cost, {
-        speed: Speed.Fast,
-        ...env,
-    }),
-    range: getTextForActivatableSkillRange(deps, value.range, {
-        speed: Speed.Fast,
-        ...env,
-    }),
-    duration: getTextForDurationForSustained(deps, value.duration, env),
+export const getFastSustainedPerformanceParametersTranslations = (getSkillModificationLevelById, locale, entity, responsiveTextSize, value) => ({
+    castingTime: getFastCastingTimeTranslation(getSkillModificationLevelById, locale, entity, responsiveTextSize, value.casting_time),
+    cost: getSustainedCostTranslation(getSkillModificationLevelById, locale, Speed.Fast, entity, responsiveTextSize, value.cost),
+    range: getTextForActivatableSkillRange(getSkillModificationLevelById, locale, Speed.Fast, responsiveTextSize, entity, value.range),
+    duration: getDurationForSustainedTranslation(locale, responsiveTextSize, value.duration),
 });
 /**
  * Get the texts for all slow one-time performance parameters.
  */
-export const getTextForSlowOneTimePerformanceParameters = (deps, value, env) => ({
-    castingTime: getTextForSlowCastingTime(deps, value.casting_time, env),
-    cost: getTextForOneTimeCost(deps, value.cost, { speed: Speed.Slow, ...env }),
-    range: getTextForActivatableSkillRange(deps, value.range, {
-        speed: Speed.Slow,
-        ...env,
-    }),
-    duration: getTextForDurationForOneTime(deps, value.duration, env),
+export const getSlowOneTimePerformanceParametersTranslations = (getSkillModificationLevelById, locale, entity, responsiveTextSize, value) => ({
+    castingTime: getSlowCastingTimeTranslation(getSkillModificationLevelById, locale, entity, responsiveTextSize, value.casting_time),
+    cost: getOneTimeCostTranslation(getSkillModificationLevelById, locale, Speed.Slow, entity, responsiveTextSize, value.cost),
+    range: getTextForActivatableSkillRange(getSkillModificationLevelById, locale, Speed.Slow, responsiveTextSize, entity, value.range),
+    duration: getDurationForOneTimeTranslation(locale, responsiveTextSize, value.duration),
 });
 /**
  * Get the texts for all slow sustained performance parameters.
  */
-export const getTextForSlowSustainedPerformanceParameters = (deps, value, env) => ({
-    castingTime: getTextForSlowCastingTime(deps, value.casting_time, env),
-    cost: getTextForSustainedCost(deps, value.cost, {
-        speed: Speed.Slow,
-        ...env,
-    }),
-    range: getTextForActivatableSkillRange(deps, value.range, {
-        speed: Speed.Slow,
-        ...env,
-    }),
-    duration: getTextForDurationForSustained(deps, value.duration, env),
+export const getSlowSustainedPerformanceParametersTranslations = (getSkillModificationLevelById, locale, entity, responsiveTextSize, value) => ({
+    castingTime: getSlowCastingTimeTranslation(getSkillModificationLevelById, locale, entity, responsiveTextSize, value.casting_time),
+    cost: getSustainedCostTranslation(getSkillModificationLevelById, locale, Speed.Slow, entity, responsiveTextSize, value.cost),
+    range: getTextForActivatableSkillRange(getSkillModificationLevelById, locale, Speed.Slow, responsiveTextSize, entity, value.range),
+    duration: getDurationForSustainedTranslation(locale, responsiveTextSize, value.duration),
 });

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

@@ -0,0 +1,20 @@
+import { LocaleEnvironment } from "../../../../helpers/locale.js";
+import { ResponsiveTextSize } from "../../responsiveText.js";
+/**
+ * Wraps the text in a translation that indicates it’s a minimum value.
+ */
+export declare const wrapAsMinimum: (locale: LocaleEnvironment, responsiveTextSize: ResponsiveTextSize, text: string) => string;
+/**
+ * Wraps the text in a translation that indicates it’s a minimum value if the
+ * `is_minimum` property says it’s a minimum value.
+ */
+export declare const wrapIfMinimum: (locale: LocaleEnvironment, responsiveTextSize: ResponsiveTextSize, is_minimum: boolean | undefined, text: string) => string;
+/**
+ * Wraps the text in a translation that indicates it’s a maximum value.
+ */
+export declare const wrapAsMaximum: (locale: LocaleEnvironment, responsiveTextSize: ResponsiveTextSize, text: string) => string;
+/**
+ * Wraps the text in a translation that indicates it’s a maximum value if the
+ * `is_maximum` property says it’s a maximum value.
+ */
+export declare const wrapIfMaximum: (locale: LocaleEnvironment, responsiveTextSize: ResponsiveTextSize, is_maximum: boolean | undefined, text: string) => string;

package/lib/entities/partial/rated/activatable/isMinimumMaximum.js

@@ -0,0 +1,19 @@
+import { responsive } from "../../responsiveText.js";
+/**
+ * Wraps the text in a translation that indicates it’s a minimum value.
+ */
+export const wrapAsMinimum = (locale, responsiveTextSize, text) => responsive(responsiveTextSize, () => locale.translate("at least {0}", text), () => locale.translate("min. {0}", text));
+/**
+ * Wraps the text in a translation that indicates it’s a minimum value if the
+ * `is_minimum` property says it’s a minimum value.
+ */
+export const wrapIfMinimum = (locale, responsiveTextSize, is_minimum, text) => is_minimum === true ? wrapAsMinimum(locale, responsiveTextSize, text) : "";
+/**
+ * Wraps the text in a translation that indicates it’s a maximum value.
+ */
+export const wrapAsMaximum = (locale, responsiveTextSize, text) => responsive(responsiveTextSize, () => locale.translate("no more than {0}", text), () => locale.translate("max. {0}", text));
+/**
+ * Wraps the text in a translation that indicates it’s a maximum value if the
+ * `is_maximum` property says it’s a maximum value.
+ */
+export const wrapIfMaximum = (locale, responsiveTextSize, is_maximum, text) => is_maximum === true ? wrapAsMaximum(locale, responsiveTextSize, text) : "";

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

@@ -0,0 +1,16 @@
+import { LocaleEnvironment } from "../../../../helpers/locale.js";
+import { ResponsiveTextSize } from "../../responsiveText.js";
+import { Entity } from "./entity.js";
+/**
+ * A parameter that is designed to be modifiable.
+ */
+export declare enum ModifiableParameter {
+    CastingTime = 0,
+    Cost = 1,
+    Range = 2
+}
+/**
+ * Returns the suffix for the text of a non-modifiable parameter that indicates
+ * that the parameter cannot be modified.
+ */
+export declare const getNonModifiableSuffixTranslation: (locale: LocaleEnvironment, entity: Entity, param: ModifiableParameter, responsiveTextSize: ResponsiveTextSize) => string;

package/lib/entities/partial/rated/activatable/nonModifiableSuffix.js

@@ -0,0 +1,55 @@
+import { mapNullable } from "@optolith/helpers/nullable";
+import { assertExhaustive } from "@optolith/helpers/typeSafety";
+import { responsive } from "../../responsiveText.js";
+import { Entity } from "./entity.js";
+/**
+ * A parameter that is designed to be modifiable.
+ */
+export var ModifiableParameter;
+(function (ModifiableParameter) {
+    ModifiableParameter[ModifiableParameter["CastingTime"] = 0] = "CastingTime";
+    ModifiableParameter[ModifiableParameter["Cost"] = 1] = "Cost";
+    ModifiableParameter[ModifiableParameter["Range"] = 2] = "Range";
+})(ModifiableParameter || (ModifiableParameter = {}));
+const translationKeyForNonModifiableSuffix = {
+    [Entity.Spell]: {
+        [ModifiableParameter.CastingTime]: " (you cannot use a modification on this spell’s casting time)",
+        [ModifiableParameter.Cost]: " (you cannot use a modification on this spell’s cost)",
+        [ModifiableParameter.Range]: " (you cannot use a modification on this spell’s range)",
+    },
+    [Entity.Ritual]: {
+        [ModifiableParameter.CastingTime]: " (you cannot use a modification on this ritual’s ritual time)",
+        [ModifiableParameter.Cost]: " (you cannot use a modification on this ritual’s cost)",
+        [ModifiableParameter.Range]: " (you cannot use a modification on this ritual’s range)",
+    },
+    [Entity.LiturgicalChant]: {
+        [ModifiableParameter.CastingTime]: " (you cannot use a modification on this chant’s liturgical time)",
+        [ModifiableParameter.Cost]: " (you cannot use a modification on this chant’s cost)",
+        [ModifiableParameter.Range]: " (you cannot use a modification on this chant’s range)",
+    },
+    [Entity.Ceremony]: {
+        [ModifiableParameter.CastingTime]: " (you cannot use a modification on this ceremony’s ceremonial time)",
+        [ModifiableParameter.Cost]: " (you cannot use a modification on this ceremony’s cost)",
+        [ModifiableParameter.Range]: " (you cannot use a modification on this ceremony’s range)",
+    },
+    [Entity.Cantrip]: undefined,
+    [Entity.Blessing]: undefined,
+};
+/**
+ * Returns the suffix for the text of a non-modifiable parameter that indicates
+ * that the parameter cannot be modified.
+ */
+export const getNonModifiableSuffixTranslation = (locale, entity, param, responsiveTextSize) => responsive(responsiveTextSize, () => mapNullable(translationKeyForNonModifiableSuffix[entity]?.[param], (key) => locale.translate(key)) ?? "", () => {
+    switch (entity) {
+        case Entity.Spell:
+        case Entity.Ritual:
+        case Entity.LiturgicalChant:
+        case Entity.Ceremony:
+            return locale.translate(" (cannot modify)");
+        case Entity.Cantrip:
+        case Entity.Blessing:
+            return "";
+        default:
+            return assertExhaustive(entity);
+    }
+});

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

@@ -7,4 +7,4 @@ export declare const parensIf: (text: string | undefined) => string;
  * Appends a string in parentheses with a leading space if it is not empty or
  * `undefined`.
  */
-export declare const appendInParens: (text: string, append: string | undefined) => string;
+export declare const appendInParensIfNotEmpty: (textToAppend: string | undefined, text: string) => string;

package/lib/entities/partial/rated/activatable/parensIf.js

@@ -7,4 +7,6 @@ export const parensIf = (text) => text === undefined || text === "" ? "" : ` (${
  * Appends a string in parentheses with a leading space if it is not empty or
  * `undefined`.
  */
-export const appendInParens = (text, append) => append === undefined || append === "" ? text : `${text} (${append})`;
+export const appendInParensIfNotEmpty = (textToAppend, text) => textToAppend === undefined || textToAppend === ""
+    ? text
+    : `${text} (${textToAppend})`;

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

@@ -2,35 +2,19 @@ import { Range } from "optolith-database-schema/types/_ActivatableSkillRange";
 import { BlessingRange } from "optolith-database-schema/types/Blessing";
 import { CantripRange } from "optolith-database-schema/types/Cantrip";
 import { GetById } from "../../../../helpers/getTypes.js";
-import { Translate, TranslateMap } from "../../../../helpers/translate.js";
+import { LocaleEnvironment } from "../../../../helpers/locale.js";
 import { ResponsiveTextSize } from "../../responsiveText.js";
 import { Entity } from "./entity.js";
 import { Speed } from "./speed.js";
 /**
  * Returns the text for the range of an activatable skill.
  */
-export declare const getTextForActivatableSkillRange: (deps: {
-    getSkillModificationLevelById: GetById.Static.SkillModificationLevel;
-    translate: Translate;
-    translateMap: TranslateMap;
-}, value: Range, env: {
-    speed: Speed;
-    responsiveText: ResponsiveTextSize;
-    entity: Entity;
-}) => string;
+export declare const getTextForActivatableSkillRange: (getSkillModificationLevelById: GetById.Static.SkillModificationLevel, locale: LocaleEnvironment, speed: Speed, responsiveTextSize: ResponsiveTextSize, entity: Entity, value: Range) => string;
 /**
  * Returns the text for the range of a cantrip.
  */
-export declare const getTextForCantripRange: (deps: {
-    translate: Translate;
-}, value: CantripRange, env: {
-    responsiveText: ResponsiveTextSize;
-}) => string;
+export declare const getTextForCantripRange: (locale: LocaleEnvironment, responsiveTextSize: ResponsiveTextSize, value: CantripRange) => string;
 /**
  * Returns the text for the range of a blessing.
  */
-export declare const getTextForBlessingRange: (deps: {
-    translate: Translate;
-}, value: BlessingRange, env: {
-    responsiveText: ResponsiveTextSize;
-}) => string;
+export declare const getTextForBlessingRange: (locale: LocaleEnvironment, responsiveTextSize: ResponsiveTextSize, value: BlessingRange) => string;

package/lib/entities/partial/rated/activatable/range.js

@@ -1,122 +1,81 @@
+import { mapNullable } from "@optolith/helpers/nullable";
 import { assertExhaustive } from "@optolith/helpers/typeSafety";
-import { getResponsiveText, getResponsiveTextOptional, responsive, } from "../../responsiveText.js";
+import { appendNoteIfRequested, replaceTextIfRequested, } from "../../responsiveText.js";
+import { formatLength } from "../../units/length.js";
 import { MISSING_VALUE } from "../../unknown.js";
-import { getTextForCheckResultBased } from "./checkResultBased.js";
-import { getTextForIsMaximum } from "./isMaximum.js";
-import { ModifiableParameter } from "./modifiableParameter.js";
-import { getTextForNonModifiableSuffix } from "./nonModifiable.js";
-import { Speed } from "./speed.js";
-const toRangeUnit = (unit, value, translate, responsiveText) => {
-    switch (unit) {
-        case "Steps":
-            return responsive(responsiveText, () => translate("{0} yards", value), () => translate("{0} yd", value));
-        case "Miles":
-            return responsive(responsiveText, () => translate("{0} miles", value), () => translate("{0} mi.", value));
-        default:
-            return assertExhaustive(unit);
-    }
-};
-/**
- * Returns the text for the range of an activatable skill.
- */
-export const getTextForActivatableSkillRange = (deps, value, env) => {
-    const translation = deps.translateMap(value.translations);
-    if (value.translations !== undefined && translation === undefined) {
-        return MISSING_VALUE;
+import { getCheckResultBasedValueTranslation } from "./checkResultBased.js";
+import { Entity } from "./entity.js";
+import { wrapIfMaximum } from "./isMinimumMaximum.js";
+import { getNonModifiableSuffixTranslation, ModifiableParameter, } from "./nonModifiableSuffix.js";
+import { getModifiableBySpeed } from "./speed.js";
+const getModifiableRangeTranslation = (getSkillModificationLevelById, locale, speed, responsiveTextSize, value) => mapNullable(getSkillModificationLevelById(value.initial_modification_level), (modificationLevel) => {
+    const range = getModifiableBySpeed((config) => config.range, (config) => config.range, speed, modificationLevel);
+    if (range === 1) {
+        return locale.translate("Touch");
     }
-    const rangeValue = (() => {
-        switch (value.value.tag) {
-            case "Modifiable": {
-                const modificationLevel = deps.getSkillModificationLevelById(value.value.modifiable.initial_modification_level);
-                if (modificationLevel === undefined) {
-                    return MISSING_VALUE;
-                }
-                const range = (() => {
-                    switch (env.speed) {
-                        case Speed.Fast:
-                            return modificationLevel.fast.range;
-                        case Speed.Slow:
-                            return modificationLevel.slow.range;
-                        default:
-                            return assertExhaustive(env.speed);
-                    }
-                })();
-                if (range === 1) {
-                    return deps.translate("Touch");
-                }
-                return toRangeUnit("Steps", range, deps.translate, env.responsiveText);
-            }
-            case "Sight":
-                return deps.translate("Sight");
-            case "Self":
-                return deps.translate("Self");
-            case "Global":
-                return deps.translate("Global");
-            case "Touch":
-                return (deps.translate("Touch") +
-                    getTextForNonModifiableSuffix(deps.translate, env.entity, ModifiableParameter.Range, env.responsiveText));
-            case "Fixed": {
-                return (toRangeUnit(value.value.fixed.unit, value.value.fixed.value, deps.translate, env.responsiveText) +
-                    getTextForNonModifiableSuffix(deps.translate, env.entity, ModifiableParameter.Range, env.responsiveText));
-            }
-            case "CheckResultBased": {
-                const isMaximum = getTextForIsMaximum(value.value.check_result_based.is_maximum, deps.translate, env.responsiveText);
-                const isRadius = value.value.check_result_based.is_radius === true
-                    ? ` ${deps.translate("Radius")}`
-                    : "";
-                return (isMaximum +
-                    toRangeUnit(value.value.check_result_based.unit, getTextForCheckResultBased(value.value.check_result_based, deps.translate), deps.translate, env.responsiveText) +
-                    isRadius +
-                    getTextForNonModifiableSuffix(deps.translate, env.entity, ModifiableParameter.Range, env.responsiveText));
-            }
-            default:
-                return assertExhaustive(value.value);
-        }
-    })();
-    const withReplacement = translation?.replacement !== undefined
-        ? getResponsiveText(translation.replacement, env.responsiveText).replace("$1", rangeValue)
-        : rangeValue;
-    const withNote = (() => {
-        if (translation?.note === undefined) {
-            return withReplacement;
-        }
-        const note = getResponsiveTextOptional(translation.note, env.responsiveText);
-        if (note === undefined) {
-            return withReplacement;
-        }
-        return `${withReplacement} (${note})`;
-    })();
-    return withNote;
+    return formatLength(locale, responsiveTextSize, "Steps", range);
+}) ?? MISSING_VALUE;
+const getSightTranslation = (locale) => locale.translate("Sight");
+const getSelfTranslation = (locale) => locale.translate("Self");
+const getGlobalTranslation = (locale) => locale.translate("Global");
+const getTouchTranslation = (locale, entity, responsiveTextSize) => locale.translate("Touch") +
+    getNonModifiableSuffixTranslation(locale, entity, ModifiableParameter.Range, responsiveTextSize);
+const getFixedRangeTranslation = (locale, entity, responsiveTextSize, value) => formatLength(locale, responsiveTextSize, value.unit, value.value) +
+    getNonModifiableSuffixTranslation(locale, entity, ModifiableParameter.Range, responsiveTextSize);
+const wrapIfRadius = (locale, is_radius, text) => (is_radius === true ? `${text} ${locale.translate("Radius")}` : text);
+const getCheckResultBasedRangeTranslation = (locale, entity, responsiveTextSize, value) => {
+    const range = formatLength(locale, responsiveTextSize, value.unit, getCheckResultBasedValueTranslation(locale.translate, value));
+    const rangeWrappedIfRadius = wrapIfRadius(locale, value.is_radius, range);
+    const rangeWrappedIfRadiusAndIfMaximum = wrapIfMaximum(locale, responsiveTextSize, value.is_maximum, rangeWrappedIfRadius);
+    return (rangeWrappedIfRadiusAndIfMaximum +
+        getNonModifiableSuffixTranslation(locale, entity, ModifiableParameter.Range, responsiveTextSize));
 };
-/**
- * Returns the text for the range of a cantrip.
- */
-export const getTextForCantripRange = (deps, value, env) => {
+const getRangeValueTranslation = (getSkillModificationLevelById, locale, speed, responsiveTextSize, entity, value) => {
     switch (value.tag) {
+        case "Modifiable":
+            return getModifiableRangeTranslation(getSkillModificationLevelById, locale, speed, responsiveTextSize, value.modifiable);
+        case "Sight":
+            return getSightTranslation(locale);
         case "Self":
-            return deps.translate("Self");
+            return getSelfTranslation(locale);
+        case "Global":
+            return getGlobalTranslation(locale);
         case "Touch":
-            return deps.translate("Touch");
+            return getTouchTranslation(locale, entity, responsiveTextSize);
         case "Fixed": {
-            return toRangeUnit(value.fixed.unit, value.fixed.value, deps.translate, env.responsiveText);
+            return getFixedRangeTranslation(locale, entity, responsiveTextSize, value.fixed);
         }
+        case "CheckResultBased":
+            return getCheckResultBasedRangeTranslation(locale, entity, responsiveTextSize, value.check_result_based);
         default:
             return assertExhaustive(value);
     }
 };
 /**
- * Returns the text for the range of a blessing.
+ * Returns the text for the range of an activatable skill.
  */
-export const getTextForBlessingRange = (deps, value, env) => {
+export const getTextForActivatableSkillRange = (getSkillModificationLevelById, locale, speed, responsiveTextSize, entity, value) => {
+    const rangeValue = getRangeValueTranslation(getSkillModificationLevelById, locale, speed, responsiveTextSize, entity, value.value);
+    const withReplacement = replaceTextIfRequested("replacement", value.translations, locale.translateMap, responsiveTextSize, rangeValue);
+    return appendNoteIfRequested("note", value.translations, locale.translateMap, responsiveTextSize, withReplacement);
+};
+const getTextForTinyAcitvatableRange = (locale, responsiveTextSize, entity, value) => {
     switch (value.tag) {
         case "Self":
-            return deps.translate("Self");
+            return getSelfTranslation(locale);
         case "Touch":
-            return deps.translate("Touch");
-        case "Fixed": {
-            return toRangeUnit(value.fixed.unit, value.fixed.value, deps.translate, env.responsiveText);
-        }
+            return getTouchTranslation(locale, entity, responsiveTextSize);
+        case "Fixed":
+            return getFixedRangeTranslation(locale, entity, responsiveTextSize, value.fixed);
         default:
             return assertExhaustive(value);
     }
 };
+/**
+ * Returns the text for the range of a cantrip.
+ */
+export const getTextForCantripRange = (locale, responsiveTextSize, value) => getTextForTinyAcitvatableRange(locale, responsiveTextSize, Entity.Cantrip, value);
+/**
+ * Returns the text for the range of a blessing.
+ */
+export const getTextForBlessingRange = (locale, responsiveTextSize, value) => getTextForTinyAcitvatableRange(locale, responsiveTextSize, Entity.Blessing, value);

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

@@ -9,4 +9,4 @@ export declare enum Speed {
 /**
  * Returns a common value for a skill modification level depending on the speed.
  */
-export declare const getModifiableBySpeed: <T>(level: SkillModificationLevel, speed: Speed, fast: (config: FastSkillModificationLevelConfig) => T, slow: (config: SlowSkillModificationLevelConfig) => T) => T;
+export declare const getModifiableBySpeed: <T>(fast: (config: FastSkillModificationLevelConfig) => T, slow: (config: SlowSkillModificationLevelConfig) => T, speed: Speed, level: SkillModificationLevel) => T;

package/lib/entities/partial/rated/activatable/speed.js

@@ -10,7 +10,7 @@ export var Speed;
 /**
  * Returns a common value for a skill modification level depending on the speed.
  */
-export const getModifiableBySpeed = (level, speed, fast, slow) => {
+export const getModifiableBySpeed = (fast, slow, speed, level) => {
     switch (speed) {
         case Speed.Fast:
             return fast(level.fast);

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

@@ -1,12 +1,8 @@
 import { TargetCategory } from "optolith-database-schema/types/_ActivatableSkillTargetCategory";
 import { GetById } from "../../../../helpers/getTypes.js";
-import { Translate, TranslateMap } from "../../../../helpers/translate.js";
-import { LibraryEntryContent } from "../../../../libraryEntry.js";
+import { LocaleEnvironment } from "../../../../helpers/locale.js";
+import { EntityDescriptionSection } from "../../../../index.js";
 /**
  * Get the text for the target category.
  */
-export declare const getTextForTargetCategory: (deps: {
-    translate: Translate;
-    translateMap: TranslateMap;
-    getTargetCategoryById: GetById.Static.TargetCategory;
-}, values: TargetCategory) => LibraryEntryContent;
+export declare const getTargetCategoryTranslation: (getTargetCategoryById: GetById.Static.TargetCategory, locale: LocaleEnvironment, values: TargetCategory) => EntityDescriptionSection;

package/lib/entities/partial/rated/activatable/targetCategory.js

@@ -1,36 +1,40 @@
 import { mapNullable } from "@optolith/helpers/nullable";
 import { assertExhaustive } from "@optolith/helpers/typeSafety";
 import { MISSING_VALUE } from "../../unknown.js";
-import { appendInParens } from "./parensIf.js";
+import { appendInParensIfNotEmpty } from "./parensIf.js";
+const getSelfTranslation = (locale) => locale.translate("Self");
+const getZoneTranslation = (locale) => locale.translate("Zone");
+const getLiturgicalChantsAndCeremoniesTranslation = (locale) => locale.translate("Liturgical Chants and Ceremonies");
+const getCantripsTranslation = (locale) => locale.translate("Cantrips");
+const getPredefinedTranslation = (getTargetCategoryById, locale, value) => {
+    const numericId = value.id.target_category;
+    const specificTargetCategory = getTargetCategoryById(numericId);
+    return (mapNullable(locale.translateMap(specificTargetCategory?.translations), (translation) => translation.name) ?? MISSING_VALUE);
+};
+const getTargetCategoryTranslationByType = (getTargetCategoryById, locale, id) => {
+    switch (id.tag) {
+        case "Self":
+            return getSelfTranslation(locale);
+        case "Zone":
+            return getZoneTranslation(locale);
+        case "LiturgicalChantsAndCeremonies":
+            return getLiturgicalChantsAndCeremoniesTranslation(locale);
+        case "Cantrips":
+            return getCantripsTranslation(locale);
+        case "Predefined":
+            return getPredefinedTranslation(getTargetCategoryById, locale, id.predefined);
+        default:
+            return assertExhaustive(id);
+    }
+};
 /**
  * Get the text for the target category.
  */
-export const getTextForTargetCategory = (deps, values) => ({
-    label: deps.translate("Target Category"),
+export const getTargetCategoryTranslation = (getTargetCategoryById, locale, values) => ({
+    label: locale.translate("Target Category"),
     value: values.length === 0
-        ? deps.translate("all")
+        ? locale.translate("all")
         : values
-            .map(({ id, translations }) => {
-            const mainName = (() => {
-                switch (id.tag) {
-                    case "Self":
-                        return deps.translate("Self");
-                    case "Zone":
-                        return deps.translate("Zone");
-                    case "LiturgicalChantsAndCeremonies":
-                        return deps.translate("Liturgical Chants and Ceremonies");
-                    case "Cantrips":
-                        return deps.translate("Cantrips");
-                    case "Predefined": {
-                        const numericId = id.predefined.id.target_category;
-                        const specificTargetCategory = deps.getTargetCategoryById(numericId);
-                        return (mapNullable(deps.translateMap(specificTargetCategory?.translations), (translation) => translation.name) ?? MISSING_VALUE);
-                    }
-                    default:
-                        return assertExhaustive(id);
-                }
-            })();
-            return appendInParens(mainName, deps.translateMap(translations)?.note);
-        })
+            .map(({ id, translations }) => appendInParensIfNotEmpty(locale.translateMap(translations)?.note, getTargetCategoryTranslationByType(getTargetCategoryById, locale, id)))
             .join(", "),
 });

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

@@ -1,7 +1,7 @@
 import { ImprovementCost as RawImprovementCost } from "optolith-database-schema/types/_ImprovementCost";
 import { Translate } from "../../../helpers/translate.js";
-import { LibraryEntryContent } from "../../../libraryEntry.js";
+import { EntityDescriptionSection } from "../../../index.js";
 /**
  * Returns the improvement cost as an inline library property.
  */
-export declare const createImprovementCost: (translate: Translate, improvementCost: RawImprovementCost) => LibraryEntryContent;
+export declare const createImprovementCost: (translate: Translate, improvementCost: RawImprovementCost) => EntityDescriptionSection;

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

@@ -2,7 +2,7 @@ import { SkillCheck, SkillCheckPenalty } from "optolith-database-schema/types/_S
 import { DerivedCharacteristic } from "optolith-database-schema/types/DerivedCharacteristic";
 import { GetById } from "../../../helpers/getTypes.js";
 import { Translate, TranslateMap } from "../../../helpers/translate.js";
-import { LibraryEntryContent } from "../../../libraryEntry.js";
+import { EntityDescriptionSection } from "../../../index.js";
 import { ResponsiveTextSize } from "../responsiveText.js";
 /**
  * Returns the skill check as an inline library property.
@@ -16,4 +16,4 @@ export declare const getTextForCheck: (deps: {
     responsiveText: ResponsiveTextSize;
     getSpirit: () => DerivedCharacteristic | undefined;
     getToughness: () => DerivedCharacteristic | undefined;
-}) => LibraryEntryContent;
+}) => EntityDescriptionSection;

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

@@ -24,8 +24,11 @@ export declare const getResponsiveText: (value: ResponsiveText | undefined, size
 export declare const getResponsiveTextOptional: (value: ResponsiveTextOptional | undefined, size: ResponsiveTextSize) => string | undefined;
 /**
  * Replaces a text with a given value if a replacement is requested, otherwise
- * just return the .
+ * just return the given value.
  */
-export declare const replaceTextIfRequested: (translation: LocaleMap<{
-    replacement?: ResponsiveTextReplace;
-}> | undefined, valueToReplace: string, translateMap: TranslateMap, responsiveText: ResponsiveTextSize) => string;
+export declare const replaceTextIfRequested: <Key extends string>(key: Key, translation: LocaleMap<{ [K in Key]?: ResponsiveTextReplace; }> | undefined, translateMap: TranslateMap, responsiveText: ResponsiveTextSize, valueToReplace: string) => string;
+/**
+ * Appends a note to a given value if a note is requested, otherwise just return
+ * the given value.
+ */
+export declare const appendNoteIfRequested: <Key extends string>(key: Key, translation: LocaleMap<{ [K in Key]?: ResponsiveTextOptional; }> | undefined, translateMap: TranslateMap, responsiveText: ResponsiveTextSize, valueToAppendTo: string) => string;

package/lib/entities/partial/responsiveText.js

@@ -1,5 +1,6 @@
 import { mapNullable } from "@optolith/helpers/nullable";
 import { assertExhaustive } from "@optolith/helpers/typeSafety";
+import { appendInParensIfNotEmpty } from "./rated/activatable/parensIf.js";
 import { MISSING_VALUE } from "./unknown.js";
 /**
  * Whether the entry is displayed in a normal or compressed setting. Normal/full
@@ -44,6 +45,11 @@ export const getResponsiveTextOptional = (value, size) => {
 };
 /**
  * Replaces a text with a given value if a replacement is requested, otherwise
- * just return the .
+ * just return the given value.
  */
-export const replaceTextIfRequested = (translation, valueToReplace, translateMap, responsiveText) => mapNullable(translateMap(translation)?.replacement, (replacement) => getResponsiveText(replacement, responsiveText).replace("$1", valueToReplace)) ?? valueToReplace;
+export const replaceTextIfRequested = (key, translation, translateMap, responsiveText, valueToReplace) => mapNullable(translateMap(translation)?.[key], (replacement) => getResponsiveText(replacement, responsiveText).replace("$1", valueToReplace)) ?? valueToReplace;
+/**
+ * Appends a note to a given value if a note is requested, otherwise just return
+ * the given value.
+ */
+export const appendNoteIfRequested = (key, translation, translateMap, responsiveText, valueToAppendTo) => mapNullable(translateMap(translation)?.[key], (note) => appendInParensIfNotEmpty(getResponsiveTextOptional(note, responsiveText), valueToAppendTo)) ?? valueToAppendTo;

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

@@ -0,0 +1,12 @@
+import { LocaleEnvironment } from "../../../helpers/locale.js";
+import { Entity } from "../rated/activatable/entity.js";
+type EnergyUnit = "ArcaneEnergy" | "KarmaPoints";
+/**
+ * Returns the text for an energy unit.
+ */
+export declare const formatEnergy: (locale: LocaleEnvironment, unit: EnergyUnit, value: number | string) => string;
+/**
+ * Returns the text for an energy unit that is based on the entity type.
+ */
+export declare const formatEnergyByEntity: (locale: LocaleEnvironment, entity: Entity, value: number | string) => string;
+export {};