@optolith/entity-descriptions 0.14.0 → 0.16.0

package/lib/index.js

@@ -15,6 +15,7 @@ import { getFocusRuleEntityDescription } from "./entities/focusRule.js";
 import { getInfluenceEntityDescription } from "./entities/influence.js";
 import { getBlessingEntityDescription, getCeremonyEntityDescription, getLiturgicalChantEntityDescription, } from "./entities/liturgicalChant.js";
 import { getOptionalRuleEntityDescription } from "./entities/optionalRule.js";
+import { ResponsiveTextSize } from "./entities/partial/responsiveText.js";
 import { getPersonalityTraitEntityDescription } from "./entities/personalityTrait.js";
 import { getPoisonEntityDescription } from "./entities/poison.js";
 import { getProfessionVersionEntityDescription } from "./entities/profession.js";
@@ -23,6 +24,7 @@ import { getSexPracticeEntityDescription } from "./entities/sexPractice.js";
 import { getSkillEntityDescription } from "./entities/skill.js";
 import { getAnimistPowerEntityDescription, getBannzeichenEntityDescription, getCantripEntityDescription, getCurseEntityDescription, getDominationRitualEntityDescription, getElvenMagicalSongEntityDescription, getFamiliarsTrickEntityDescription, getGeodeRitualEntityDescription, getGoblinRitualEntityDescription, getJesterTrickEntityDescription, getMagicalDanceEntityDescription, getMagicalMelodyEntityDescription, getMagicalRuneEntityDescription, getRitualEntityDescription, getSpellEntityDescription, getZibiljaRitualEntityDescription, } from "./entities/spell.js";
 import { getStateEntityDescription } from "./entities/state.js";
+import { getTradeSecretEntityDescription } from "./entities/tradeSecret.js";
 const registeredEntityDescriptionCreators = {
     // rules
     // CoreRule: getCoreRuleEntityDescription,
@@ -124,6 +126,8 @@ const registeredEntityDescriptionCreators = {
     Vision: getActivatableEntityDescription,
     WandEnchantment: getActivatableEntityDescription,
     WeaponEnchantment: getActivatableEntityDescription,
+    // auxiliary special ability
+    TradeSecret: getTradeSecretEntityDescription,
     // equipment
     Ammunition: getEquipmentEntityDescription,
     Animal: getEquipmentEntityDescription,
@@ -177,7 +181,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, publicationOptions) => {
+export const getEntityDescription = (database, localeEnv, idMap, getResolvedSelectOptionById, getAllResolvedSelectOptions, getAllResolvedNewSkillApplications, getAllResolvedSkillUses, entityName, instanceId, publicationOptions, responsiveTextSize = "Full") => {
     const creator = registeredEntityDescriptionCreators[entityName];
     const instance = database.getInstanceOfEntityById(entityName, instanceId);
     if (!instance) {
@@ -193,5 +197,9 @@ export const getEntityDescription = (database, localeEnv, idMap, getResolvedSele
         getAllResolvedNewSkillApplications,
         getAllResolvedSkillUses,
         idMap,
+        ...localeEnv,
+        localeJoin: localeEnv.join,
+        localeCompare: localeEnv.compare,
+        responsiveTextSize: ResponsiveTextSize[responsiveTextSize],
     }, localeEnv, { entity: entityName, content: instance, id: instanceId }, { publications: publicationOptions });
 };

package/lib/rawEntityDescription.d.ts

@@ -0,0 +1,144 @@
+import type { AnyNonNullish } from "@elyukai/utils/nullable";
+import type { Reader } from "@elyukai/utils/reader";
+import type { Errata, PublicationRefs } from "@optolith/database-schema/gen";
+/**
+ * A JSON representation of the rules text for a library entry that has not been
+ * cleaned up.
+ */
+export type RawEntityDescription<Cols extends string = string, E = AnyNonNullish> = RawTextEntityDescription<E> | RawTabularEntityDescription<Cols, E> | RawTabularEntityDescription<Cols, E>[];
+/**
+ * A JSON representation of the rules text for a library entry that has not been
+ * cleaned up.
+ */
+export type RawTextEntityDescription<E> = {
+    type?: "text";
+    category?: {
+        label: Reader<E, string>;
+        value: Reader<E, string>;
+    };
+    title: string;
+    subtitle?: string;
+    badge?: RawEntityDescriptionBadge;
+    className: string;
+    body: (RawEntityDescriptionSection | RawEntityDescriptionSectionR<E> | undefined)[];
+    errata?: Errata;
+    references?: PublicationRefs;
+};
+/**
+ * A JSON representation of the table for a library entry that has not been
+ * cleaned up.
+ */
+export type RawTabularEntityDescription<Cols extends string, E> = {
+    type: "tabular";
+    category?: {
+        label: Reader<E, string>;
+        value: Reader<E, string>;
+    };
+    title: string;
+    labels: {
+        [K in Cols]: Reader<E, string>;
+    };
+    values: {
+        [K in Cols]: Reader<E, string>;
+    };
+    additionalInformation?: ({
+        label: Reader<E, string>;
+        id: string;
+        value: Reader<E, string | undefined>;
+    } | undefined)[];
+    errata?: Errata;
+    references?: PublicationRefs;
+};
+/**
+ * A badge that can be displayed next to the title of a library entry.
+ */
+export type RawEntityDescriptionBadge = {
+    type: "level" | "armedCombat" | "unarmedCombat";
+    value: string;
+};
+/**
+ * A labeled or unlabeled section of a library entry text.
+ */
+export type RawEntityDescriptionSection = RawEntityDescriptionSectionContent<RawDefinitionListEntityDescriptionSection> | RawLabeledEntityDescriptionSection;
+/**
+ * A labeled or unlabeled section of a library entry text.
+ */
+export type RawEntityDescriptionSectionR<E> = RawEntityDescriptionSectionContent<RawDefinitionListEntityDescriptionSectionR<E>> | RawLabeledEntityDescriptionSectionR<E>;
+/**
+ * A slice of the content of a library entry text.
+ */
+export type RawEntityDescriptionSectionContent<DL> = RawPlainEntityDescriptionSection | DL | RawTableEntityDescriptionSection;
+/**
+ * A labeled section of a library entry text.
+ */
+export type RawLabeledEntityDescriptionSection = {
+    type: "labeled";
+    label: string;
+    value: RawEntityDescriptionSectionContent<RawDefinitionListEntityDescriptionSection>;
+};
+/**
+ * A labeled section of a library entry text.
+ */
+export type RawLabeledEntityDescriptionSectionR<E> = {
+    type: "labeled";
+    label: string;
+    value: RawEntityDescriptionSectionContent<RawDefinitionListEntityDescriptionSectionR<E>>;
+};
+/**
+ * A plain text, possibly containing Markdown syntax.
+ */
+export type RawPlainEntityDescriptionSection = {
+    type: "plain";
+    text: string;
+};
+/**
+ * A list of labeled values, such as prerequisites or quality levels.
+ */
+export type RawDefinitionListEntityDescriptionSection = {
+    type: "definitionList";
+    items: (RawDefinitionListEntityDescriptionSectionItem | undefined)[];
+};
+/**
+ * A list of labeled values, such as prerequisites or quality levels.
+ */
+export type RawDefinitionListEntityDescriptionSectionR<E> = {
+    type: "definitionList";
+    items: (RawDefinitionListEntityDescriptionSectionItemR<E> | undefined)[];
+};
+/**
+ * A list of labeled values, such as prerequisites or quality levels, nested within another definition list.
+ */
+export type RawNestedDefinitionListEntityDescriptionSection = {
+    type: "definitionList";
+    /**
+     * How to render this definition list.
+     *
+     * - `"hidden"`: The definition list does not look like it is nested, it just looks like it belongs to its parent definition list.
+     * - `"nested"`: The definition list is visually nested inside its parent definition list, usually indented and with italic labels instead of bold ones.
+     */
+    style: "hidden" | "nested";
+    items: (RawDefinitionListEntityDescriptionSectionItem | undefined)[];
+};
+/**
+ * A single labeled value in a definition list.
+ */
+export type RawDefinitionListEntityDescriptionSectionItem = {
+    label: string;
+    value: string | (RawEntityDescriptionSectionContent<RawNestedDefinitionListEntityDescriptionSection> | undefined)[];
+};
+/**
+ * A single labeled value in a definition list.
+ */
+export type RawDefinitionListEntityDescriptionSectionItemR<E> = {
+    label: Reader<E, string>;
+    value: Reader<E, string | (RawEntityDescriptionSectionContent<RawNestedDefinitionListEntityDescriptionSection> | undefined)[]>;
+};
+/**
+ * A table with a header, rows, and an optional footer.
+ */
+export type RawTableEntityDescriptionSection = {
+    type: "table";
+    header: string[];
+    rows: string[][];
+    footer?: string[];
+};

package/lib/rawEntityDescription.js

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

package/lib/references/index.d.ts

@@ -1,8 +1,7 @@
 import type { PublicationRefs } from "@optolith/database-schema/gen";
-import type { GetInstanceById } from "../helpers/getTypes.js";
-import type { LocaleEnvironment } from "../helpers/locale.js";
+import type { StdReader } from "../env.js";
 import { type PublicationOptions } from "./publicationOptions.js";
 /**
  * Returns the translation of the references.
  */
-export declare const getReferencesTranslation: (getInstanceById: GetInstanceById<"Publication">, publicationOptions: PublicationOptions, locale: LocaleEnvironment, references: PublicationRefs) => string;
+export declare const getReferencesTranslation: (publicationOptions: PublicationOptions, references: PublicationRefs) => StdReader<string, "t" | "tm" | "ibi", "Publication">;

package/lib/references/index.js

@@ -1,41 +1,36 @@
+import { Reader } from "@elyukai/utils/reader";
 import { isNotNullish } from "@optolith/helpers/nullable";
 import { assertExhaustive } from "@optolith/helpers/typeSafety";
+import { getInstanceByIdR, sequence, translateMapR, translateR, } from "../entities/partial/reader.js";
 import { fromRawPageRange, normalizePageRanges, printPageRanges } from "./pageRange.js";
 import { isPublicationIncluded } from "./publicationOptions.js";
 /**
  * Returns the translation of the references.
  */
-export const getReferencesTranslation = (getInstanceById, publicationOptions, locale, references) => references
-    .map(ref => {
-    const publication = getInstanceById("Publication", ref.id);
-    const publicationTranslations = locale.translateMap(publication?.translations);
-    const occurrences = locale.translateMap(ref.occurrences);
+export const getReferencesTranslation = (publicationOptions, references) => Reader.traverse(references, ref => getInstanceByIdR("Publication", ref.id).thenW(publication => translateMapR(publication?.translations).thenW(publicationTranslation => translateMapR(ref.occurrences).thenW(occurrences => {
     if (publication === undefined ||
-        publicationTranslations === undefined ||
+        publicationTranslation === undefined ||
         occurrences === undefined ||
         (publicationOptions.onlyShowReferencesToIncludedPublications &&
             !isPublicationIncluded(publicationOptions, ref.id, publication))) {
-        return undefined;
+        return Reader.of(undefined);
     }
     const initialPageRanges = normalizePageRanges(occurrences.initial.pages.map(fromRawPageRange));
     const initial = occurrences.initial.printing === undefined
-        ? printPageRanges(locale.translate, initialPageRanges)
-        : `${printPageRanges(locale.translate, initialPageRanges)} (${locale.translate(".input {$printing :number} {{since the {$printing}. printing}}", { printing: occurrences.initial.printing })})`;
+        ? printPageRanges(initialPageRanges)
+        : sequence `${printPageRanges(initialPageRanges)} (${translateR(".input {$printing :number} {{since the {$printing}. printing}}", { printing: occurrences.initial.printing })})`;
     const revisions = occurrences.revisions?.map(rev => {
         switch (rev.kind) {
             case "Since": {
                 const pageRanges = normalizePageRanges(rev.Since.pages.map(fromRawPageRange));
-                return `${printPageRanges(locale.translate, pageRanges)} (${locale.translate(".input {$printing :number} {{since the {$printing}. printing}}", { printing: rev.Since.printing })})`;
+                return sequence `${printPageRanges(pageRanges)} (${translateR(".input {$printing :number} {{since the {$printing}. printing}}", { printing: rev.Since.printing })})`;
             }
             case "Deprecated": {
-                return locale.translate(".input {$printing :number} {{removed in {$printing}. printing}}", { printing: rev.Deprecated.printing });
+                return translateR(".input {$printing :number} {{removed in {$printing}. printing}}", { printing: rev.Deprecated.printing });
             }
             default:
                 return assertExhaustive(rev);
         }
     }) ?? [];
-    const allPageRanges = [initial, ...revisions].join("; ");
-    return `${publicationTranslations.name} ${allPageRanges}`;
-})
-    .filter(isNotNullish)
-    .join("; ");
+    return Reader.sequence([initial, ...revisions]).map(list => `${publicationTranslation.name} ${list.join("; ")}`);
+})))).map(list => list.filter(isNotNullish).join("; "));

package/lib/references/page.d.ts

@@ -1,6 +1,6 @@
+import { Reader } from "@elyukai/utils/reader";
 import type { Page } from "@optolith/database-schema/gen";
 import type { Compare } from "@optolith/helpers/compare";
-import type { Translate } from "../helpers/translate.js";
 /**
  * A comparison function for two pages.
  */
@@ -20,4 +20,6 @@ export declare const numberToPage: (number: number) => Page;
 /**
  * Returns a string representation of a page.
  */
-export declare const printPage: (translate: Translate, page: Page) => string;
+export declare const printPage: (page: Page) => Reader<{
+    translate: import("../helpers/translate.js").Translate;
+}, string>;

package/lib/references/page.js

@@ -1,4 +1,6 @@
+import { Reader } from "@elyukai/utils/reader";
 import { assertExhaustive } from "@optolith/helpers/typeSafety";
+import { translateR } from "../entities/partial/reader.js";
 /**
  * A comparison function for two pages.
  */
@@ -47,14 +49,14 @@ export const numberToPage = (number) => ({
 /**
  * Returns a string representation of a page.
  */
-export const printPage = (translate, page) => {
+export const printPage = (page) => {
     switch (page.kind) {
         case "InsideCoverFront":
-            return translate("Front Cover Inside");
+            return translateR("Front Cover Inside");
         case "InsideCoverBack":
-            return translate("Back Cover Inside");
+            return translateR("Back Cover Inside");
         case "Numbered":
-            return page.Numbered.toFixed();
+            return Reader.of(page.Numbered.toFixed());
         default:
             return assertExhaustive(page);
     }

package/lib/references/pageRange.d.ts

@@ -1,5 +1,5 @@
 import type { Page, PageRange as RawPageRange } from "@optolith/database-schema/gen";
-import type { Translate } from "../helpers/translate.js";
+import type { StdReader } from "../env.js";
 /**
  * A range of pages, including the first and last page, if the range includes
  * more than on page.
@@ -19,8 +19,8 @@ export declare const normalizePageRanges: (ranges: PageRange[]) => PageRange[];
 /**
  * Returns a string representation of a page range.
  */
-export declare const printPageRange: (translate: Translate, pageRange: PageRange) => string;
+export declare const printPageRange: (pageRange: PageRange) => StdReader<string, "t">;
 /**
  * Returns a string representation of a list of page ranges.
  */
-export declare const printPageRanges: (translate: Translate, pageRanges: PageRange[]) => string;
+export declare const printPageRanges: (pageRanges: PageRange[]) => StdReader<string, "t">;

package/lib/references/pageRange.js

@@ -1,4 +1,6 @@
+import { Reader } from "@elyukai/utils/reader";
 import { range } from "@optolith/helpers/array";
+import { sequence } from "../entities/partial/reader.js";
 import { comparePage, equalsPage, printPage, succ } from "./page.js";
 /**
  * Converts a page object range from the database to a local page object range.
@@ -40,10 +42,10 @@ export const normalizePageRanges = (ranges) => ranges
 /**
  * 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)}`;
+export const printPageRange = (pageRange) => pageRange.lastPage === undefined
+    ? printPage(pageRange.firstPage)
+    : sequence `${printPage(pageRange.firstPage)}–${printPage(pageRange.lastPage)}`;
 /**
  * Returns a string representation of a list of page ranges.
  */
-export const printPageRanges = (translate, pageRanges) => pageRanges.map(pageRange => printPageRange(translate, pageRange)).join(", ");
+export const printPageRanges = (pageRanges) => Reader.traverse(pageRanges, printPageRange).map(list => list.join(", "));