@optolith/entity-descriptions 0.14.0 → 0.16.0

package/lib/entityDescription.d.ts

@@ -0,0 +1,118 @@
+/**
+ * A JSON representation of the rules text for a library entry.
+ */
+export type EntityDescription<Cols extends string> = TextEntityDescription | TabularEntityDescription<Cols> | TabularEntityDescription<Cols>[];
+/**
+ * A JSON representation of the rules text for a library entry.
+ */
+export type TextEntityDescription = {
+    type?: "text";
+    category?: {
+        label: string;
+        value: string;
+    };
+    title: string;
+    subtitle?: string;
+    badge?: EntityDescriptionBadge;
+    className: string;
+    body: EntityDescriptionSection[];
+    errata?: {
+        date: string;
+        description: string;
+    }[];
+    references?: string;
+};
+/**
+ * A JSON representation of the rules text for a library entry.
+ */
+export type TabularEntityDescription<Cols extends string> = {
+    type: "tabular";
+    category?: {
+        label: string;
+        value: string;
+    };
+    title: string;
+    labels: {
+        [K in Cols]: string;
+    };
+    values: {
+        [K in Cols]: string;
+    };
+    additionalInformation?: {
+        label: string;
+        id: string;
+        value: string;
+    }[];
+    errata?: {
+        date: string;
+        description: string;
+    }[];
+    references?: string;
+};
+/**
+ * A badge that can be displayed next to the title of a library entry.
+ */
+export type EntityDescriptionBadge = {
+    type: "level" | "armedCombat" | "unarmedCombat";
+    value: string;
+};
+/**
+ * A labeled or unlabeled section of a library entry text.
+ */
+export type EntityDescriptionSection = EntityDescriptionSectionContent<DefinitionListEntityDescriptionSection> | LabeledEntityDescriptionSection;
+/**
+ * A slice of the content of a library entry text.
+ */
+export type EntityDescriptionSectionContent<DL> = PlainEntityDescriptionSection | DL | TableEntityDescriptionSection;
+/**
+ * A labeled section of a library entry text.
+ */
+export type LabeledEntityDescriptionSection = {
+    type: "labeled";
+    label: string;
+    value: EntityDescriptionSectionContent<DefinitionListEntityDescriptionSection>;
+};
+/**
+ * A plain text, possibly containing Markdown syntax.
+ */
+export type PlainEntityDescriptionSection = {
+    type: "plain";
+    text: string;
+};
+/**
+ * A list of labeled values, such as prerequisites or quality levels.
+ */
+export type DefinitionListEntityDescriptionSection = {
+    type: "definitionList";
+    items: DefinitionListEntityDescriptionSectionItem[];
+};
+/**
+ * A list of labeled values, such as prerequisites or quality levels, nested within another definition list.
+ */
+export type NestedDefinitionListEntityDescriptionSection = {
+    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: DefinitionListEntityDescriptionSectionItem[];
+};
+/**
+ * A single labeled value in a definition list.
+ */
+export type DefinitionListEntityDescriptionSectionItem = {
+    label: string;
+    value: string | EntityDescriptionSectionContent<NestedDefinitionListEntityDescriptionSection>[];
+};
+/**
+ * A table with a header, rows, and an optional footer.
+ */
+export type TableEntityDescriptionSection = {
+    type: "table";
+    header: string[];
+    rows: string[][];
+    footer?: string[];
+};

package/lib/entityDescription.js

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

package/lib/env.d.ts

@@ -1,14 +1,15 @@
 import type { AnyNonNullish } from "@elyukai/utils/nullable";
 import type { Reader } from "@elyukai/utils/reader";
-import type { ChildEntityMap, EntityMap } from "@optolith/database-schema/gen";
+import type { ChildEntityMap, EntityMap, LocaleMeasurementAdjustments } from "@optolith/database-schema/gen";
 import type { GetResolvedSelectOptionById } from "./entities/partial/prerequisites/single/activatable.js";
 import type { ModifiableParameter } from "./entities/partial/rated/activatable/nonModifiableSuffix.js";
 import type { Speed } from "./entities/partial/rated/activatable/speed.js";
 import type { ResponsiveTextSize } from "./entities/partial/responsiveText.js";
 import { type EnergyUnit } from "./entities/partial/units/energy.js";
 import type { GetAllChildInstancesForParent, GetAllInstances, GetInstanceById } from "./helpers/getTypes.js";
-import type { FormatNumber, LocaleCompare, LocaleJoin } from "./helpers/locale.js";
+import type { FormatDate, FormatNumber, LocaleCompare, LocaleJoin } from "./helpers/locale.js";
 import type { Format, Translate, TranslateMap, TranslationKeysWithoutParams } from "./helpers/translate.js";
+import type { IdMap } from "./index.js";
 import type { PublicationOptions } from "./references/publicationOptions.js";
 /**
  * The standard set of environment properties for readers in this project.
@@ -16,6 +17,7 @@ import type { PublicationOptions } from "./references/publicationOptions.js";
 export type EnvMap<E extends keyof EntityMap = never, AE extends keyof EntityMap = never, CE extends keyof ChildEntityMap = never> = {
     format: Format;
     formatNumber: FormatNumber;
+    formatDate: FormatDate;
     translate: Translate;
     translateMap: TranslateMap;
     localeJoin: LocaleJoin;
@@ -30,6 +32,8 @@ export type EnvMap<E extends keyof EntityMap = never, AE extends keyof EntityMap
     getResolvedSelectOptionById: GetResolvedSelectOptionById;
     publicationOptions: PublicationOptions;
     displayedInProfession: boolean;
+    measurementAdjustments: Required<LocaleMeasurementAdjustments>;
+    idMap: IdMap;
 };
 /**
  * Shortcuts for selecting keys of the shared environment map type.
@@ -37,6 +41,7 @@ export type EnvMap<E extends keyof EntityMap = never, AE extends keyof EntityMap
 export type EnvMapAbbr = {
     f: "format";
     fn: "formatNumber";
+    fd: "formatDate";
     t: "translate";
     tm: "translateMap";
     lj: "localeJoin";
@@ -51,6 +56,8 @@ export type EnvMapAbbr = {
     rso: "getResolvedSelectOptionById";
     po: "publicationOptions";
     dip: "displayedInProfession";
+    ma: "measurementAdjustments";
+    idm: "idMap";
 };
 /**
  * The standard set of environment properties for readers in this project.

package/lib/helpers/locale.d.ts

@@ -31,3 +31,7 @@ export type LocaleJoin = (list: string[], type: LocaleJoinType) => string;
  * A function that formats a number according to the locale’s rules.
  */
 export type FormatNumber = (value: number) => string;
+/**
+ * A function that formats a date according to the locale’s rules.
+ */
+export type FormatDate = (date: Date) => string;