@optolith/entity-descriptions 0.3.2 → 0.4.1

package/lib/index.d.ts

@@ -6,12 +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 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?: {
@@ -43,6 +45,7 @@ export type EntityDescriptionSectionContent<DL = DefinitionListEntityDescription
 export type RawEntityDescription = {
     title: string;
     subtitle?: string;
+    badge?: number;
     className: string;
     body: (RawEntityDescriptionSection | undefined)[];
     errata?: Errata;
@@ -847,11 +850,18 @@ declare const registeredEntityDescriptionCreators: {
         getInstanceById: GetInstanceById<"Publication">;
     }, EntityDescription>;
 };
-type AvailableCreatorEntity = keyof typeof registeredEntityDescriptionCreators;
+/**
+ * The set of entities for which there is a registered description creator function.
+ */
+export type AvailableCreatorEntity = keyof typeof registeredEntityDescriptionCreators;
 /**
  * Checks if there is a registered description creator for the given entity name.
  */
 export declare const isSupportedEntity: (entityName: string) => entityName is AvailableCreatorEntity;
+/**
+ * The list of entity names for which there is a registered description creator function.
+ */
+export declare const supportedEntities: AvailableCreatorEntity[];
 /**
  * Human-readable aliases for certain identifiers in the database.
  */
@@ -875,4 +885,3 @@ export type GetAllResolvedSkillUses = (id: Skill_ID) => ResolvedSkillUse[];
  * Get a JSON representation of the rules text for an entry in the database.
  */
 export declare const getEntityDescription: <E extends AvailableCreatorEntity>(database: TSONDB<TSONDBTypes>, localeEnv: LocaleEnvironment, idMap: IdMap, getResolvedSelectOptionById: GetResolvedSelectOptionById, getAllResolvedSelectOptions: GetAllResolvedSelectOptions, getAllResolvedNewSkillApplications: GetAllResolvedNewSkillApplications, getAllResolvedSkillUses: GetAllResolvedSkillUses, entityName: E, instanceId: string) => EntityDescription | undefined;
-export {};

package/lib/index.js

@@ -164,9 +164,14 @@ const registeredEntityDescriptionCreators = {
  * Checks if there is a registered description creator for the given entity name.
  */
 export const isSupportedEntity = (entityName) => entityName in registeredEntityDescriptionCreators;
+/**
+ * The list of entity names for which there is a registered description creator function.
+ */
+export const supportedEntities = Object.keys(registeredEntityDescriptionCreators).toSorted();
 /**
  * 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.