@optolith/entity-descriptions 0.1.1 → 0.2.0

package/lib/references/pageRange.js

@@ -0,0 +1,58 @@
+import { range } from "@optolith/helpers/array";
+import { comparePage, equalsPage, numberToPage, printPage, succ, } from "./page.js";
+/**
+ * Converts a numeric range to a page object range.
+ */
+export const numberRangeToPageRange = (numberRange) => numberRange.last_page === undefined
+    ? { firstPage: numberToPage(numberRange.first_page) }
+    : {
+        firstPage: numberToPage(numberRange.first_page),
+        lastPage: numberToPage(numberRange.last_page),
+    };
+/**
+ * Converts a page object range from the database to a local page object range.
+ */
+export const fromRawPageRange = (pageRange) => pageRange.last_page === undefined
+    ? { firstPage: pageRange.first_page }
+    : {
+        firstPage: pageRange.first_page,
+        lastPage: pageRange.last_page,
+    };
+/**
+ * Sorts and combines page ranges while removing duplicates.
+ */
+export const normalizePageRanges = (ranges) => ranges
+    .flatMap(({ firstPage, lastPage = firstPage }) => {
+    if (firstPage.tag === "Numbered" && lastPage.tag === "Numbered") {
+        return range(firstPage.numbered, lastPage.numbered).map((numbered) => ({
+            tag: "Numbered",
+            numbered,
+        }));
+    }
+    else {
+        return [firstPage, lastPage];
+    }
+})
+    .filter((page, i, pages) => pages.findIndex((p) => equalsPage(page, p)) === i)
+    .sort(comparePage)
+    .reduce((acc, page) => {
+    const lastRange = acc[acc.length - 1];
+    if (lastRange === undefined) {
+        return [{ firstPage: page }];
+    }
+    const { firstPage, lastPage = firstPage } = lastRange;
+    if (equalsPage(page, succ(lastPage))) {
+        return [...acc.slice(0, -1), { firstPage, lastPage: page }];
+    }
+    return [...acc, { firstPage: page }];
+}, []);
+/**
+ * Returns a string representation of a page range.
+ */
+export const printPageRange = (translate, pageRange) => pageRange.lastPage === undefined
+    ? printPage(translate, pageRange.firstPage)
+    : `${printPage(translate, pageRange.firstPage)}–${printPage(translate, pageRange.lastPage)}`;
+/**
+ * Returns a string representation of a list of page ranges.
+ */
+export const printPageRanges = (translate, pageRanges) => pageRanges.map((pageRange) => printPageRange(translate, pageRange)).join(", ");

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@optolith/entity-descriptions",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "An interface for generating descriptions for The Dark Eye entities.",
   "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./entities/*": "./lib/entities/*.js"
+  },
   "scripts": {
     "build": "tsc -b",
     "watch": "tsc -b -w",
     "release": "commit-and-tag-version",
-    "test": "glob -c \"node --import tsx --test\" \"./src/**/*.test.ts\""
+    "test": "glob -c \"node --import tsx --test\" \"./test/**/*.ts\""
   },
   "repository": {
     "type": "git",
@@ -26,7 +30,7 @@
     "@types/node": "^22.7.4",
     "commit-and-tag-version": "^12.4.4",
     "glob": "^11.0.0",
-    "optolith-database-schema": "^0.17.0",
+    "optolith-database-schema": "^0.17.2",
     "tsx": "^4.19.1",
     "typescript": "^5.6.2"
   },

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

@@ -1,6 +0,0 @@
-import { Translate } from "../../../../helpers/translate.js";
-import { ResponsiveTextSize } from "../../responsiveText.js";
-/**
- * Returns the text to prepend for the `is_maximum` property.
- */
-export declare const getTextForIsMaximum: (is_maximum: boolean | undefined, translate: Translate, responsiveText: ResponsiveTextSize) => string;

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

@@ -1,10 +0,0 @@
-import { responsive } from "../../responsiveText.js";
-/**
- * Returns the text to prepend for the `is_maximum` property.
- */
-export const getTextForIsMaximum = (is_maximum, translate, responsiveText) => {
-    if (is_maximum !== true) {
-        return "";
-    }
-    return responsive(responsiveText, () => translate("no more than "), () => translate("max. "));
-};

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

@@ -1,8 +0,0 @@
-/**
- * A parameter that is designed to be modifiable.
- */
-export declare enum ModifiableParameter {
-    CastingTime = 0,
-    Cost = 1,
-    Range = 2
-}

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

@@ -1,9 +0,0 @@
-/**
- * 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 = {}));

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

@@ -1,9 +0,0 @@
-import { Translate } from "../../../../helpers/translate.js";
-import { ResponsiveTextSize } from "../../responsiveText.js";
-import { Entity } from "./entity.js";
-import { ModifiableParameter } from "./modifiableParameter.js";
-/**
- * Returns the suffix for the text of a non-modifiable parameter that indicates
- * that the parameter cannot be modified.
- */
-export declare const getTextForNonModifiableSuffix: (translate: Translate, entity: Entity, param: ModifiableParameter, responsiveText: ResponsiveTextSize) => string;

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

@@ -1,75 +0,0 @@
-import { assertExhaustive } from "@optolith/helpers/typeSafety";
-import { ResponsiveTextSize } from "../../responsiveText.js";
-import { Entity } from "./entity.js";
-import { ModifiableParameter } from "./modifiableParameter.js";
-/**
- * Returns the suffix for the text of a non-modifiable parameter that indicates
- * that the parameter cannot be modified.
- */
-export const getTextForNonModifiableSuffix = (translate, entity, param, responsiveText) => {
-    if (responsiveText === ResponsiveTextSize.Compressed) {
-        switch (entity) {
-            case Entity.Spell:
-            case Entity.Ritual:
-            case Entity.LiturgicalChant:
-            case Entity.Ceremony:
-                return translate(" (cannot modify)");
-            case Entity.Cantrip:
-            case Entity.Blessing:
-                return "";
-            default:
-                return assertExhaustive(entity);
-        }
-    }
-    switch (entity) {
-        case Entity.Spell:
-            switch (param) {
-                case ModifiableParameter.CastingTime:
-                    return translate(" (you cannot use a modification on this spell’s casting time)");
-                case ModifiableParameter.Cost:
-                    return translate(" (you cannot use a modification on this spell’s cost)");
-                case ModifiableParameter.Range:
-                    return translate(" (you cannot use a modification on this spell’s range)");
-                default:
-                    return assertExhaustive(param);
-            }
-        case Entity.Ritual:
-            switch (param) {
-                case ModifiableParameter.CastingTime:
-                    return translate(" (you cannot use a modification on this ritual’s ritual time)");
-                case ModifiableParameter.Cost:
-                    return translate(" (you cannot use a modification on this ritual’s cost)");
-                case ModifiableParameter.Range:
-                    return translate(" (you cannot use a modification on this ritual’s range)");
-                default:
-                    return assertExhaustive(param);
-            }
-        case Entity.LiturgicalChant:
-            switch (param) {
-                case ModifiableParameter.CastingTime:
-                    return translate(" (you cannot use a modification on this chant’s liturgical time)");
-                case ModifiableParameter.Cost:
-                    return translate(" (you cannot use a modification on this chant’s cost)");
-                case ModifiableParameter.Range:
-                    return translate(" (you cannot use a modification on this chant’s range)");
-                default:
-                    return assertExhaustive(param);
-            }
-        case Entity.Ceremony:
-            switch (param) {
-                case ModifiableParameter.CastingTime:
-                    return translate(" (you cannot use a modification on this ceremony’s ceremonial time)");
-                case ModifiableParameter.Cost:
-                    return translate(" (you cannot use a modification on this ceremony’s cost)");
-                case ModifiableParameter.Range:
-                    return translate(" (you cannot use a modification on this ceremony’s range)");
-                default:
-                    return assertExhaustive(param);
-            }
-        case Entity.Cantrip:
-        case Entity.Blessing:
-            return "";
-        default:
-            return assertExhaustive(entity);
-    }
-};

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

@@ -1,13 +0,0 @@
-import { Translate } from "../../../../helpers/translate.js";
-import { ResponsiveTextSize } from "../../responsiveText.js";
-import { Entity } from "./entity.js";
-type TimeSpanUnit = "Seconds" | "Minutes" | "Hours" | "Days" | "Weeks" | "Months" | "Years" | "Centuries" | "Actions" | "CombatRounds" | "SeductionActions" | "Rounds";
-/**
- * Returns the text for a time span unit.
- */
-export declare const formatTimeSpan: (translate: Translate, responsiveTextSize: ResponsiveTextSize, unit: TimeSpanUnit, value: number | string) => string;
-/**
- * Returns the text for a cost unit that is based on the entity type.
- */
-export declare const formatCost: (translate: Translate, entity: Entity, value: number | string) => string;
-export {};

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

@@ -1,53 +0,0 @@
-import { assertExhaustive } from "@optolith/helpers/typeSafety";
-import { responsive } from "../../responsiveText.js";
-import { Entity } from "./entity.js";
-/**
- * Returns the text for a time span unit.
- */
-export const formatTimeSpan = (translate, responsiveTextSize, unit, value) => {
-    switch (unit) {
-        case "Seconds":
-            return responsive(responsiveTextSize, () => translate("{0} seconds", value), () => translate("{0} s", value));
-        case "Minutes":
-            return responsive(responsiveTextSize, () => translate("{0} minutes", value), () => translate("{0} min", value));
-        case "Hours":
-            return responsive(responsiveTextSize, () => translate("{0} hours", value), () => translate("{0} h", value));
-        case "Days":
-            return responsive(responsiveTextSize, () => translate("{0} days", value), () => translate("{0} d", value));
-        case "Weeks":
-            return responsive(responsiveTextSize, () => translate("{0} weeks", value), () => translate("{0} wks.", value));
-        case "Months":
-            return responsive(responsiveTextSize, () => translate("{0} months", value), () => translate("{0} mos.", value));
-        case "Years":
-            return responsive(responsiveTextSize, () => translate("{0} years", value), () => translate("{0} yrs.", value));
-        case "Centuries":
-            return responsive(responsiveTextSize, () => translate("{0} centuries", value), () => translate("{0} cent.", value));
-        case "Actions":
-            return responsive(responsiveTextSize, () => translate("{0} actions", value), () => translate("{0} act", value));
-        case "CombatRounds":
-            return responsive(responsiveTextSize, () => translate("{0} combat rounds", value), () => translate("{0} CR", value));
-        case "SeductionActions":
-            return responsive(responsiveTextSize, () => translate("{0} seduction actions", value), () => translate("{0} SA", value));
-        case "Rounds":
-            return responsive(responsiveTextSize, () => translate("{0} rounds", value), () => translate("{0} rnds", value));
-        default:
-            return assertExhaustive(unit);
-    }
-};
-/**
- * Returns the text for a cost unit that is based on the entity type.
- */
-export const formatCost = (translate, entity, value) => {
-    switch (entity) {
-        case Entity.Cantrip:
-        case Entity.Spell:
-        case Entity.Ritual:
-            return translate("{0} AE", value);
-        case Entity.Blessing:
-        case Entity.LiturgicalChant:
-        case Entity.Ceremony:
-            return translate("{0} KP", value);
-        default:
-            return assertExhaustive(entity);
-    }
-};

package/lib/libraryEntry.d.ts

@@ -1,52 +0,0 @@
-import { Compare } from "@optolith/helpers/compare";
-import { PublicationRefs } from "optolith-database-schema/types/source/_PublicationRef";
-import { Translate, TranslateMap } from "./helpers/translate.js";
-/**
- * Creates a function that creates the JSON representation of the rules text for
- * a library entry.
- */
-export declare const createLibraryEntryCreator: <T, A = undefined>(fn: LibraryEntryCreator<T, A, RawLibraryEntry>) => LibraryEntryCreator<T | undefined, A>;
-/**
- * A function that creates the JSON representation of the rules text for a
- * library entry if given further params to the returned function.
- */
-export type LibraryEntryCreator<T, A = undefined, R = LibraryEntry> = (entry: T, ...args: A extends undefined ? [] : [A]) => LibraryEntryConfiguredCreator<R>;
-/**
- * A function that is already configures for a specific entity and returns the
- * JSON representation of the rules text for a ibrary entry.
- */
-export type LibraryEntryConfiguredCreator<R = LibraryEntry> = (params: {
-    translate: Translate;
-    translateMap: TranslateMap;
-    localeCompare: Compare<string>;
-}) => R | undefined;
-/**
- * A JSON representation of the rules text for a library entry.
- */
-export type LibraryEntry = {
-    title: string;
-    subtitle?: string;
-    className: string;
-    content: LibraryEntryContent[];
-    src?: PublicationRefs;
-};
-/**
- * A JSON representation of the rules text for a library entry that has not been
- * cleaned up.
- */
-export type RawLibraryEntry = {
-    title: string;
-    subtitle?: string;
-    className: string;
-    content: (LibraryEntryContent | undefined)[];
-    src?: PublicationRefs;
-};
-/**
- * A slice of the content of a library entry text.
- */
-export type LibraryEntryContent = {
-    label?: string;
-    value: string | number;
-    noIndent?: boolean;
-    className?: string;
-};

package/lib/libraryEntry.js

@@ -1,17 +0,0 @@
-import { filterNonNullable } from "@optolith/helpers/array";
-/**
- * Creates a function that creates the JSON representation of the rules text for
- * a library entry.
- */
-export const createLibraryEntryCreator = (fn) => (entry, ...args) => {
-    if (entry === undefined) {
-        return () => undefined;
-    }
-    return (params) => {
-        const rawEntry = fn(entry, ...args)(params);
-        if (rawEntry === undefined) {
-            return undefined;
-        }
-        return { ...rawEntry, content: filterNonNullable(rawEntry.content) };
-    };
-};