@optolith/entity-descriptions 0.11.0 → 0.11.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optolith/entity-descriptions",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "An interface for generating descriptions for The Dark Eye entities.",
   "files": [
     "lib",

package/lib/entities/partial/prerequisites/single/anyActivatableOfGroup.d.ts

@@ -1,7 +0,0 @@
-import type { TinyActivatablePrerequisite } from "@optolith/database-schema/gen";
-import { type StdReader } from "../../reader.js";
-import type { PrerequisitePart } from "../part.js";
-/**
- * Get the translation of a tiny activatable prerequisite.
- */
-export declare const printTinyActivatablePrerequisite: (prerequisite: TinyActivatablePrerequisite) => StdReader<PrerequisitePart | undefined, "tm" | "ibi", "Blessing" | "Cantrip">;

package/lib/entities/partial/prerequisites/single/anyActivatableOfGroup.js

@@ -1,16 +0,0 @@
-import { attributedCustomNameR } from "../../reader.js";
-import { MISSING_VALUE } from "../../unknown.js";
-import { printDisplayOptionR } from "../displayOption.js";
-/**
- * Get the translation of a tiny activatable prerequisite.
- */
-export const printTinyActivatablePrerequisite = (prerequisite) => {
-    if (prerequisite.display_option !== undefined) {
-        return printDisplayOptionR(prerequisite.display_option);
-    }
-    return attributedCustomNameR("prerequisite", (t) => t.abbreviation ?? t.name, prerequisite.id).map(name => ({
-        value: name ?? MISSING_VALUE,
-        sentenceType: undefined,
-        isMeta: false,
-    }));
-};

package/lib/entities/partial/prerequisites/single/rated copy.d.ts

@@ -1,8 +0,0 @@
-import type { RatedPrerequisite } from "@optolith/database-schema/gen";
-import { type GetInstanceById } from "../../../../helpers/getTypes.js";
-import type { LocaleEnvironment } from "../../../../helpers/locale.js";
-import type { PrerequisitePart } from "../part.js";
-/**
- * Get the translation of a blessed tradition prerequisite.
- */
-export declare const printRatedPrerequisite: (getInstanceById: GetInstanceById<"Attribute" | "Skill" | "CloseCombatTechnique" | "RangedCombatTechnique" | "Spell" | "Ritual" | "LiturgicalChant" | "Ceremony">, locale: Pick<LocaleEnvironment, "translateMap">, prerequisite: RatedPrerequisite) => PrerequisitePart | undefined;

package/lib/entities/partial/prerequisites/single/rated copy.js

@@ -1,17 +0,0 @@
-import { attributedCustomName } from "../../markdown.js";
-import { MISSING_VALUE } from "../../unknown.js";
-import { printDisplayOption } from "../displayOption.js";
-/**
- * Get the translation of a blessed tradition prerequisite.
- */
-export const printRatedPrerequisite = (getInstanceById, locale, prerequisite) => {
-    if (prerequisite.display_option !== undefined) {
-        return printDisplayOption(locale.translateMap, prerequisite.display_option);
-    }
-    const name = attributedCustomName(locale.translateMap, getInstanceById, "prerequisite", (t) => t.abbreviation ?? t.name, prerequisite.id) ?? MISSING_VALUE;
-    return {
-        value: prerequisite.value > 0 ? `${name} ${prerequisite.value.toFixed()}` : name,
-        sentenceType: undefined,
-        isMeta: false,
-    };
-};

package/lib/entities/partial/prerequisites/single/tinyActivatable copy.d.ts

@@ -1,7 +0,0 @@
-import type { TinyActivatablePrerequisite } from "@optolith/database-schema/gen";
-import { type StdReader } from "../../reader.js";
-import type { PrerequisitePart } from "../part.js";
-/**
- * Get the translation of a tiny activatable prerequisite.
- */
-export declare const printTinyActivatablePrerequisite: (prerequisite: TinyActivatablePrerequisite) => StdReader<PrerequisitePart | undefined, "tm" | "ibi", "Blessing" | "Cantrip">;

package/lib/entities/partial/prerequisites/single/tinyActivatable copy.js

@@ -1,16 +0,0 @@
-import { attributedCustomNameR } from "../../reader.js";
-import { MISSING_VALUE } from "../../unknown.js";
-import { printDisplayOptionR } from "../displayOption.js";
-/**
- * Get the translation of a tiny activatable prerequisite.
- */
-export const printTinyActivatablePrerequisite = (prerequisite) => {
-    if (prerequisite.display_option !== undefined) {
-        return printDisplayOptionR(prerequisite.display_option);
-    }
-    return attributedCustomNameR("prerequisite", (t) => t.abbreviation ?? t.name, prerequisite.id).map(name => ({
-        value: name ?? MISSING_VALUE,
-        sentenceType: undefined,
-        isMeta: false,
-    }));
-};

package/lib/helpers/publicationOptions.d.ts

@@ -1,42 +0,0 @@
-import type { Publication, Publication_ID } from "@optolith/database-schema/gen";
-import type { GetInstanceById } from "./getTypes.js";
-/**
- * Options for how to render information from different publications in entity descriptions.
- */
-export type PublicationOptions = {
-    /**
-     * A list of publications to include, identified by their ID. These will always be included no matter the settings in `showPublicationGroups`.
-     */
-    publications: Publication_ID[];
-    /**
-     * Which publication groups to include, no matter if they are explicitly referenced or not.
-     *
-     * - `"none"`: No groups, only explicitly referenced publications
-     * - `"core"`: Core rules
-     * - `"playerOriented"`: Core rules and player-oriented supplements, excluding books with adult content and adventure books.
-     * - `"playerOrientedWithAdult"`: Core rules and player-oriented supplements, excluding adventure books but including books with adult content.
-     * - `"playerOrientedWithAdventures"`: Core rules and player-oriented supplements, including adventure books but excluding books with adult content.
-     * - `"all"`: All groups, including books with adult content and adventure books. Any explicit publication references will have no effect as all publications are included anyway.
-     */
-    showPublicationGroups: "none" | "core" | "playerOriented" | "playerOrientedWithAdult" | "playerOrientedWithAdventures" | "all";
-    /**
-     * How to handle different printings of the same publication.
-     *
-     * - `"none"`: No handling, new and removed entries are treated equally.
-     * - `"latestOnly"`: Only the latest printing of a publication is included, older revisions are ignored.
-     * - `Record<Publication_ID, number>`: A custom handling for each publication, where the number indicates the printing to include.
-     */
-    printingHandling: "none" | "latestOnly" | Record<Publication_ID, number>;
-    /**
-     * If true, only publication references to publications included via `publications` and `showPublicationGroups` will be shown.
-     */
-    onlyShowReferencesToIncludedPublications: boolean;
-};
-/**
- *
- */
-export declare const isPublicationIncluded: (publicationOptions: PublicationOptions, publicationId: Publication_ID, publication: Publication) => boolean;
-/**
- *
- */
-export declare const isPublicationIncludedById: (getInstanceById: GetInstanceById<"Publication">, publicationOptions: PublicationOptions, publicationId: Publication_ID) => boolean;

package/lib/helpers/publicationOptions.js

@@ -1,64 +0,0 @@
-import { assertExhaustive } from "@elyukai/utils/typeSafety";
-const isPublicationIncludedInGroup = (publication, publicationOptions) => {
-    switch (publicationOptions.showPublicationGroups) {
-        case "none":
-            return false;
-        case "core":
-            switch (publication.category.kind) {
-                case "CoreRules":
-                    return true;
-                case "ExpansionRules":
-                case "Sourcebook":
-                case "RegionalSourcebook":
-                case "Adventure":
-                    return false;
-                default:
-                    return assertExhaustive(publication.category);
-            }
-        case "playerOriented":
-            switch (publication.category.kind) {
-                case "CoreRules":
-                case "ExpansionRules":
-                case "Sourcebook":
-                case "RegionalSourcebook":
-                    return !publication.containsAdultContent;
-                case "Adventure":
-                    return false;
-                default:
-                    return assertExhaustive(publication.category);
-            }
-        case "playerOrientedWithAdult":
-            switch (publication.category.kind) {
-                case "CoreRules":
-                case "ExpansionRules":
-                case "Sourcebook":
-                case "RegionalSourcebook":
-                    return true;
-                case "Adventure":
-                    return false;
-                default:
-                    return assertExhaustive(publication.category);
-            }
-        case "playerOrientedWithAdventures":
-            return !publication.containsAdultContent;
-        case "all":
-            return true;
-        default:
-            return assertExhaustive(publicationOptions.showPublicationGroups);
-    }
-};
-/**
- *
- */
-export const isPublicationIncluded = (publicationOptions, publicationId, publication) => publicationOptions.publications.includes(publicationId) ||
-    isPublicationIncludedInGroup(publication, publicationOptions);
-/**
- *
- */
-export const isPublicationIncludedById = (getInstanceById, publicationOptions, publicationId) => {
-    const publication = getInstanceById("Publication", publicationId);
-    if (publication === undefined) {
-        return false;
-    }
-    return isPublicationIncluded(publicationOptions, publicationId, publication);
-};