@optolith/entity-descriptions 0.2.0 → 0.3.1

package/lib/index.js

@@ -1,22 +1,187 @@
-import { filterNonNullable } from "@optolith/helpers/array";
-import { getReferencesTranslation } from "./references/index.js";
+import { getActivatableEntityDescription } from "./entities/activatable.js";
+import { getAlternativeRuleEntityDescription } from "./entities/alternativeRule.js";
+import { getAttributeEntityDescription } from "./entities/attribute.js";
+import { getCloseCombatTechniqueEntityDescription, getRangedCombatTechniqueEntityDescription, } from "./entities/combatTechnique.js";
+import { getConditionEntityDescription, getMetaConditionEntityDescription, } from "./entities/condition.js";
+import { getCultureEntityDescription } from "./entities/culture.js";
+import { getCurriculumEntityDescription } from "./entities/curriculum.js";
+import { getDerivedCharacteristicEntityDescription } from "./entities/derivedCharacteristic.js";
+import { getDiseaseEntityDescription } from "./entities/disease.js";
+import { getElixirEntityDescription } from "./entities/elixir.js";
+import { getEquipmentEntityDescription } from "./entities/equipment.js";
+import { getEquipmentPackageEntityDescription } from "./entities/equipmentPackage.js";
+import { getExperienceLevelEntityDescription } from "./entities/experienceLevel.js";
+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 { getPersonalityTraitEntityDescription } from "./entities/personalityTrait.js";
+import { getPoisonEntityDescription } from "./entities/poison.js";
+import { getProfessionVersionEntityDescription } from "./entities/profession.js";
+import { getRaceEntityDescription } from "./entities/race.js";
+import { getSexPracticeEntityDescription } from "./entities/sexPractice.js";
+import { getSkillEntityDescription } from "./entities/skill.js";
+import { getAnimistPowerEntityDescription, getCantripEntityDescription, getCurseEntityDescription, getDominationRitualEntityDescription, getElvenMagicalSongEntityDescription, getFamiliarsTrickEntityDescription, getGeodeRitualEntityDescription, getJesterTrickEntityDescription, getMagicalDanceEntityDescription, getMagicalMelodyEntityDescription, getMagicalRuneEntityDescription, getRitualEntityDescription, getSpellEntityDescription, getZibiljaRitualEntityDescription, } from "./entities/spell.js";
+import { getStateEntityDescription } from "./entities/state.js";
+const registeredEntityDescriptionCreators = {
+    // rules
+    // CoreRule: getCoreRuleEntityDescription,
+    FocusRule: getFocusRuleEntityDescription,
+    OptionalRule: getOptionalRuleEntityDescription,
+    AlternativeRule: getAlternativeRuleEntityDescription,
+    Condition: getConditionEntityDescription,
+    MetaCondition: getMetaConditionEntityDescription,
+    State: getStateEntityDescription,
+    // character creation
+    ExperienceLevel: getExperienceLevelEntityDescription,
+    DerivedCharacteristic: getDerivedCharacteristicEntityDescription,
+    Race: getRaceEntityDescription,
+    Culture: getCultureEntityDescription,
+    ProfessionVersion: getProfessionVersionEntityDescription,
+    Advantage: getActivatableEntityDescription,
+    Disadvantage: getActivatableEntityDescription,
+    // core values
+    Attribute: getAttributeEntityDescription,
+    Skill: getSkillEntityDescription,
+    CloseCombatTechnique: getCloseCombatTechniqueEntityDescription,
+    RangedCombatTechnique: getRangedCombatTechniqueEntityDescription,
+    // spellworks
+    Cantrip: getCantripEntityDescription,
+    Spell: getSpellEntityDescription,
+    Ritual: getRitualEntityDescription,
+    // magical actions
+    AnimistPower: getAnimistPowerEntityDescription,
+    Curse: getCurseEntityDescription,
+    DominationRitual: getDominationRitualEntityDescription,
+    ElvenMagicalSong: getElvenMagicalSongEntityDescription,
+    GeodeRitual: getGeodeRitualEntityDescription,
+    JesterTrick: getJesterTrickEntityDescription,
+    MagicalDance: getMagicalDanceEntityDescription,
+    MagicalMelody: getMagicalMelodyEntityDescription,
+    MagicalRune: getMagicalRuneEntityDescription,
+    ZibiljaRitual: getZibiljaRitualEntityDescription,
+    // auxiliary magical
+    Curriculum: getCurriculumEntityDescription,
+    FamiliarsTrick: getFamiliarsTrickEntityDescription,
+    // work of the gods
+    Blessing: getBlessingEntityDescription,
+    LiturgicalChant: getLiturgicalChantEntityDescription,
+    Ceremony: getCeremonyEntityDescription,
+    // special abilities and enchantments
+    AdvancedCombatSpecialAbility: getActivatableEntityDescription,
+    AdvancedKarmaSpecialAbility: getActivatableEntityDescription,
+    AdvancedMagicalSpecialAbility: getActivatableEntityDescription,
+    AdvancedSkillSpecialAbility: getActivatableEntityDescription,
+    AncestorGlyph: getActivatableEntityDescription,
+    ArcaneOrbEnchantment: getActivatableEntityDescription,
+    AttireEnchantment: getActivatableEntityDescription,
+    Beutelzauber: getActivatableEntityDescription,
+    BlessedTradition: getActivatableEntityDescription,
+    BowlEnchantment: getActivatableEntityDescription,
+    BrawlingSpecialAbility: getActivatableEntityDescription,
+    CauldronEnchantment: getActivatableEntityDescription,
+    CeremonialItemSpecialAbility: getActivatableEntityDescription,
+    ChronicleEnchantment: getActivatableEntityDescription,
+    CombatSpecialAbility: getActivatableEntityDescription,
+    CombatStyleSpecialAbility: getActivatableEntityDescription,
+    CommandSpecialAbility: getActivatableEntityDescription,
+    DaggerRitual: getActivatableEntityDescription,
+    FamiliarSpecialAbility: getActivatableEntityDescription,
+    FatePointSexSpecialAbility: getActivatableEntityDescription,
+    FatePointSpecialAbility: getActivatableEntityDescription,
+    FoolsHatEnchantment: getActivatableEntityDescription,
+    GeneralSpecialAbility: getActivatableEntityDescription,
+    Haubenzauber: getActivatableEntityDescription,
+    InstrumentEnchantment: getActivatableEntityDescription,
+    KarmaSpecialAbility: getActivatableEntityDescription,
+    Krallenkettenzauber: getActivatableEntityDescription,
+    Kristallkugelzauber: getActivatableEntityDescription,
+    LiturgicalStyleSpecialAbility: getActivatableEntityDescription,
+    LycantropicGift: getActivatableEntityDescription,
+    MagicalSign: getActivatableEntityDescription,
+    MagicalSpecialAbility: getActivatableEntityDescription,
+    MagicalTradition: getActivatableEntityDescription,
+    MagicStyleSpecialAbility: getActivatableEntityDescription,
+    OrbEnchantment: getActivatableEntityDescription,
+    PactGift: getActivatableEntityDescription,
+    ProtectiveWardingCircleSpecialAbility: getActivatableEntityDescription,
+    RingEnchantment: getActivatableEntityDescription,
+    Sermon: getActivatableEntityDescription,
+    SexSpecialAbility: getActivatableEntityDescription,
+    SickleRitual: getActivatableEntityDescription,
+    SikaryanDrainSpecialAbility: getActivatableEntityDescription,
+    SkillStyleSpecialAbility: getActivatableEntityDescription,
+    SpellSwordEnchantment: getActivatableEntityDescription,
+    StaffEnchantment: getActivatableEntityDescription,
+    ToyEnchantment: getActivatableEntityDescription,
+    Trinkhornzauber: getActivatableEntityDescription,
+    VampiricGift: getActivatableEntityDescription,
+    Vision: getActivatableEntityDescription,
+    WandEnchantment: getActivatableEntityDescription,
+    WeaponEnchantment: getActivatableEntityDescription,
+    // equipment
+    Ammunition: getEquipmentEntityDescription,
+    Animal: getEquipmentEntityDescription,
+    AnimalCare: getEquipmentEntityDescription,
+    Armor: getEquipmentEntityDescription,
+    BandageOrRemedy: getEquipmentEntityDescription,
+    Book: getEquipmentEntityDescription,
+    CeremonialItem: getEquipmentEntityDescription,
+    Clothes: getEquipmentEntityDescription,
+    ClothingPackage: getEquipmentEntityDescription,
+    Container: getEquipmentEntityDescription,
+    Elixir: getElixirEntityDescription,
+    EquipmentOfBlessedOnes: getEquipmentEntityDescription,
+    GemOrPreciousStone: getEquipmentEntityDescription,
+    IlluminationLightSource: getEquipmentEntityDescription,
+    IlluminationRefillOrSupply: getEquipmentEntityDescription,
+    Jewelry: getEquipmentEntityDescription,
+    Laboratory: getEquipmentEntityDescription,
+    Liebesspielzeug: getEquipmentEntityDescription,
+    LuxuryGood: getEquipmentEntityDescription,
+    MagicalArtifact: getEquipmentEntityDescription,
+    MusicalInstrument: getEquipmentEntityDescription,
+    Newspaper: getEquipmentEntityDescription,
+    OrienteeringAid: getEquipmentEntityDescription,
+    Poison: getPoisonEntityDescription,
+    RopeOrChain: getEquipmentEntityDescription,
+    Stationery: getEquipmentEntityDescription,
+    ThievesTool: getEquipmentEntityDescription,
+    ToolOfTheTrade: getEquipmentEntityDescription,
+    TravelGearOrTool: getEquipmentEntityDescription,
+    Vehicle: getEquipmentEntityDescription,
+    Weapon: getEquipmentEntityDescription,
+    WeaponAccessory: getEquipmentEntityDescription,
+    EquipmentPackage: getEquipmentPackageEntityDescription,
+    // other
+    Disease: getDiseaseEntityDescription,
+    AnimalDisease: getDiseaseEntityDescription,
+    Influence: getInfluenceEntityDescription,
+    PersonalityTrait: getPersonalityTraitEntityDescription,
+    SexPractice: getSexPracticeEntityDescription,
+};
 /**
- * Creates a function that creates the JSON representation of the rules text for
- * a library entry.
+ * Checks if there is a registered description creator for the given entity name.
  */
-export const createEntityDescriptionCreator = (fn) => (databaseAccessors, locale, entry) => {
-    if (entry === undefined) {
-        return undefined;
-    }
-    const rawEntry = fn(databaseAccessors, locale, entry);
-    if (rawEntry === undefined) {
+export const isSupportedEntity = (entityName) => entityName in registeredEntityDescriptionCreators;
+/**
+ * Get a JSON representation of the rules text for an entry in the database.
+ */
+export const getEntityDescription = (database, localeEnv, idMap, getResolvedSelectOptionById, getAllResolvedSelectOptions, getAllResolvedNewSkillApplications, getAllResolvedSkillUses, entityName, instanceId) => {
+    const creator = registeredEntityDescriptionCreators[entityName];
+    const instance = database.getInstanceOfEntityById(entityName, instanceId);
+    if (!instance) {
         return undefined;
     }
-    return {
-        ...rawEntry,
-        body: filterNonNullable(rawEntry.body),
-        references: rawEntry.references === undefined
-            ? undefined
-            : getReferencesTranslation(databaseAccessors.getPublicationById, locale, rawEntry.references),
-    };
+    return creator({
+        getInstanceById: database.getInstanceOfEntityById.bind(database),
+        getAllInstances: database.getAllInstanceContainersOfEntity.bind(database),
+        countInstances: database.countInstancesOfEntity.bind(database),
+        getChildInstancesForInstanceId: (childEntityName, parentId) => database.getAllChildInstanceContainersForParent(childEntityName, parentId),
+        getResolvedSelectOptionById,
+        getAllResolvedSelectOptions,
+        getAllResolvedNewSkillApplications,
+        getAllResolvedSkillUses,
+        idMap,
+    }, localeEnv, { entity: entityName, content: instance, id: instanceId });
 };

package/lib/references/index.d.ts

@@ -1,4 +1,7 @@
-import { PublicationRefs } from "optolith-database-schema/types/source/_PublicationRef";
-import { GetById } from "../helpers/getTypes.js";
+import type { PublicationRefs } from "optolith-database-schema/gen";
+import type { GetInstanceById } from "../helpers/getTypes.js";
 import { LocaleEnvironment } from "../helpers/locale.js";
-export declare const getReferencesTranslation: (getPublicationById: GetById.Static.Publication, locale: LocaleEnvironment, references: PublicationRefs) => string;
+/**
+ * Returns the translation of the references.
+ */
+export declare const getReferencesTranslation: (getInstanceById: GetInstanceById<"Publication">, locale: LocaleEnvironment, references: PublicationRefs) => string;

package/lib/references/index.js

@@ -1,10 +1,12 @@
 import { isNotNullish } from "@optolith/helpers/nullable";
 import { assertExhaustive } from "@optolith/helpers/typeSafety";
-import { isSimpleOccurrence, isSimpleOccurrences, isVersionedOccurrence, } from "./occurrence.js";
-import { fromRawPageRange, normalizePageRanges, numberRangeToPageRange, printPageRange, printPageRanges, } from "./pageRange.js";
-export const getReferencesTranslation = (getPublicationById, locale, references) => references
-    .map((ref) => {
-    const publication = getPublicationById(ref.id.publication);
+import { fromRawPageRange, normalizePageRanges, printPageRanges, } from "./pageRange.js";
+/**
+ * Returns the translation of the references.
+ */
+export const getReferencesTranslation = (getInstanceById, locale, references) => references
+    .map(ref => {
+    const publication = getInstanceById("Publication", ref.id);
     const publicationTranslations = locale.translateMap(publication?.translations);
     const occurrences = locale.translateMap(ref.occurrences);
     if (publication === undefined ||
@@ -12,35 +14,25 @@ export const getReferencesTranslation = (getPublicationById, locale, references)
         occurrences === undefined) {
         return undefined;
     }
-    if (isSimpleOccurrence(occurrences)) {
-        return `${publicationTranslations.name} ${printPageRange(locale.translate, numberRangeToPageRange(occurrences))}`;
-    }
-    if (isSimpleOccurrences(occurrences)) {
-        const ranges = normalizePageRanges(occurrences.map(numberRangeToPageRange));
-        return `${publicationTranslations.name} ${printPageRanges(locale.translate, ranges)}`;
-    }
-    if (isVersionedOccurrence(occurrences)) {
-        const initialPageRanges = normalizePageRanges(occurrences.initial.pages.map(fromRawPageRange));
-        const initial = occurrences.initial.printing === undefined
-            ? printPageRanges(locale.translate, initialPageRanges)
-            : `${printPageRanges(locale.translate, initialPageRanges)} (${locale.translate("since the {0}. printing", occurrences.initial.printing)})`;
-        const revisions = occurrences.revisions?.map((rev) => {
-            switch (rev.tag) {
-                case "Since": {
-                    const pageRanges = normalizePageRanges(rev.since.pages.map(fromRawPageRange));
-                    return `${printPageRanges(locale.translate, pageRanges)} (${locale.translate("since the {0}. printing", rev.since.printing)})`;
-                }
-                case "Deprecated": {
-                    return locale.translate("removed in {0}. printing", rev.deprecated.printing);
-                }
-                default:
-                    return assertExhaustive(rev);
+    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 })})`;
+    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 })})`;
             }
-        }) ?? [];
-        const allPageRanges = [initial, ...revisions].join("; ");
-        return `${publicationTranslations.name} ${allPageRanges}`;
-    }
-    return assertExhaustive(occurrences);
+            case "Deprecated": {
+                return locale.translate(".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("; ");

package/lib/references/page.d.ts

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

package/lib/references/page.js

@@ -3,15 +3,15 @@ import { assertExhaustive } from "@optolith/helpers/typeSafety";
  * A comparison function for two pages.
  */
 export const comparePage = (a, b) => {
-    switch (a.tag) {
+    switch (a.kind) {
         case "InsideCoverFront":
-            return b.tag === "InsideCoverFront" ? 0 : -1;
+            return b.kind === "InsideCoverFront" ? 0 : -1;
         case "InsideCoverBack":
-            return b.tag === "InsideCoverBack" ? 0 : 1;
+            return b.kind === "InsideCoverBack" ? 0 : 1;
         case "Numbered":
-            return b.tag === "Numbered"
-                ? a.numbered - b.numbered
-                : b.tag === "InsideCoverFront"
+            return b.kind === "Numbered"
+                ? a.Numbered - b.Numbered
+                : b.kind === "InsideCoverFront"
                     ? 1
                     : -1;
         default:
@@ -26,13 +26,13 @@ export const equalsPage = (a, b) => comparePage(a, b) === 0;
  * Returns the successor of a page.
  */
 export const succ = (page) => {
-    switch (page.tag) {
+    switch (page.kind) {
         case "InsideCoverFront":
-            return { tag: "Numbered", numbered: 1 };
+            return { kind: "Numbered", Numbered: 1 };
         case "InsideCoverBack":
-            return { tag: "InsideCoverFront", inside_cover_front: {} };
+            return { kind: "InsideCoverFront" };
         case "Numbered":
-            return { tag: "Numbered", numbered: page.numbered + 1 };
+            return { kind: "Numbered", Numbered: page.Numbered + 1 };
         default:
             return assertExhaustive(page);
     }
@@ -41,20 +41,20 @@ export const succ = (page) => {
  * Creates a page object for a page number.
  */
 export const numberToPage = (number) => ({
-    tag: "Numbered",
-    numbered: number,
+    kind: "Numbered",
+    Numbered: number,
 });
 /**
  * Returns a string representation of a page.
  */
 export const printPage = (translate, page) => {
-    switch (page.tag) {
+    switch (page.kind) {
         case "InsideCoverFront":
             return translate("Front Cover Inside");
         case "InsideCoverBack":
             return translate("Back Cover Inside");
         case "Numbered":
-            return page.numbered.toString();
+            return page.Numbered.toString();
         default:
             return assertExhaustive(page);
     }

package/lib/references/pageRange.d.ts

@@ -1,4 +1,4 @@
-import { Page, PageRange as RawPageRange, SimpleOccurrence } from "optolith-database-schema/types/source/_PublicationRef";
+import { Page, PageRange as RawPageRange } from "optolith-database-schema/gen";
 import { Translate } from "../helpers/translate.js";
 /**
  * A range of pages, including the first and last page, if the range includes
@@ -8,10 +8,6 @@ export type PageRange = {
     firstPage: Page;
     lastPage?: Page;
 };
-/**
- * Converts a numeric range to a page object range.
- */
-export declare const numberRangeToPageRange: (numberRange: SimpleOccurrence) => PageRange;
 /**
  * Converts a page object range from the database to a local page object range.
  */

package/lib/references/pageRange.js

@@ -1,14 +1,5 @@
 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),
-    };
+import { comparePage, equalsPage, printPage, succ } from "./page.js";
 /**
  * Converts a page object range from the database to a local page object range.
  */
@@ -23,17 +14,17 @@ export const fromRawPageRange = (pageRange) => pageRange.last_page === undefined
  */
 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,
+    if (firstPage.kind === "Numbered" && lastPage.kind === "Numbered") {
+        return range(firstPage.Numbered, lastPage.Numbered).map(numbered => ({
+            kind: "Numbered",
+            Numbered: numbered,
         }));
     }
     else {
         return [firstPage, lastPage];
     }
 })
-    .filter((page, i, pages) => pages.findIndex((p) => equalsPage(page, p)) === i)
+    .filter((page, i, pages) => pages.findIndex(p => equalsPage(page, p)) === i)
     .sort(comparePage)
     .reduce((acc, page) => {
     const lastRange = acc[acc.length - 1];
@@ -55,4 +46,4 @@ export const printPageRange = (translate, pageRange) => pageRange.lastPage === u
 /**
  * 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 = (translate, pageRanges) => pageRanges.map(pageRange => printPageRange(translate, pageRange)).join(", ");