optolith-database-schema 0.11.4 → 0.11.6

package/lib/types/Cantrip.d.ts

@@ -0,0 +1,183 @@
+/**
+ * @main Cantrip
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { CastingTimeDuringLovemaking } from "./_ActivatableSkillCastingTime.js";
+import { DurationUnit } from "./_ActivatableSkillDuration.js";
+import { FixedRange } from "./_ActivatableSkillRange.js";
+import { TargetCategory } from "./_ActivatableSkillTargetCategory.js";
+import { Enhancements } from "./_Enhancements.js";
+import { MagicalTraditionIdentifier } from "./_Identifier.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { ResponsiveText } from "./_ResponsiveText.js";
+import { CurriculumReference, MagicalTraditionReference, PropertyReference } from "./_SimpleReferences.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Cantrip
+ */
+export type Cantrip = {
+    /**
+     * The cantrip's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Measurable parameters of a cantrip.
+     */
+    parameters: CantripPerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory;
+    /**
+     * The associated property.
+     */
+    property: PropertyReference;
+    /**
+     * A note specifying the dissemination of the cantrip in different traditions.
+     * Sometimes a cantrip is exclusively available to one or more specific
+     * traditions, but usually one the academies and traditions are listed the
+     * cantrip is most commonly teached in.
+     */
+    note?: CantripNote;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<CantripTranslation>;
+    enhancements?: Enhancements;
+};
+export type CantripNote = {
+    tag: "Exclusive";
+    exclusive: ExclusiveCantripNote;
+} | {
+    tag: "Common";
+    common: CommonCantripNotes;
+};
+export type ExclusiveCantripNote = {
+    /**
+     * The traditions the cantrip is exclusively available to.
+     * @minItems 1
+     * @uniqueItems
+     */
+    traditions: MagicalTraditionReference[];
+};
+export type CommonCantripNotes = {
+    /**
+     * The academies and traditions the cantrip is commonly teached in.
+     * @minItems 1
+     * @uniqueItems
+     */
+    list: CommonCantripNote[];
+};
+export type CommonCantripNote = {
+    tag: "Academy";
+    academy: CurriculumReference;
+} | {
+    tag: "Tradition";
+    tradition: CommonCantripTraditionNote;
+};
+export type CommonCantripTraditionNote = {
+    /**
+     * The magical tradition's identifier.
+     */
+    id: MagicalTraditionIdentifier;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations?: LocaleMap<CommonCantripTraditionNoteTranslation>;
+};
+export type CommonCantripTraditionNoteTranslation = {
+    /**
+     * A note, appended to the generated string in parenthesis.
+     * @minLength 1
+     */
+    note: string;
+};
+export type CantripTranslation = {
+    /**
+     * The name of the spell.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * The effect description.
+     * @markdown
+     * @minLength 1
+     */
+    effect: string;
+    /**
+     * @deprecated
+     */
+    range: string;
+    /**
+     * @deprecated
+     */
+    duration: string;
+    /**
+     * @deprecated
+     */
+    target: string;
+    errata?: Errata;
+};
+/**
+ * Measurable parameters of a blessing.
+ */
+export type CantripPerformanceParameters = {
+    range: CantripRange;
+    duration: CantripDuration;
+};
+export type CantripRange = {
+    tag: "Self";
+    self: {};
+} | {
+    tag: "Touch";
+    touch: {};
+} | {
+    tag: "Fixed";
+    fixed: FixedRange;
+};
+export type CantripDuration = {
+    tag: "Immediate";
+    immediate: {};
+} | {
+    tag: "Fixed";
+    fixed: FixedCantripDuration;
+} | {
+    tag: "DuringLovemaking";
+    during_lovemaking: CastingTimeDuringLovemaking;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteCantripDuration;
+};
+export type FixedCantripDuration = {
+    /**
+     * If `true`, the duration is a maximum duration.
+     */
+    is_maximum?: true;
+    /**
+     * The (unitless) duration.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The duration unit.
+     */
+    unit: DurationUnit;
+};
+export type IndefiniteCantripDuration = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteDurationTranslation>;
+};
+export type IndefiniteDurationTranslation = {
+    /**
+     * A description of the duration.
+     */
+    description: ResponsiveText;
+};
+export declare const config: TypeConfig<Cantrip>;

package/lib/types/Cantrip.js

@@ -0,0 +1,12 @@
+/**
+ * @main Cantrip
+ */
+import { todo } from "../validation/builders/integrity.js";
+import { createSchemaValidator } from "../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../validation/filename.js";
+export const config = {
+    name: "Cantrip",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Cantrip"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/Ceremony.d.ts

@@ -0,0 +1,113 @@
+/**
+ * @main Ceremony
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { SlowPerformanceParameters } from "./_ActivatableSkill.js";
+import { Effect } from "./_ActivatableSkillEffect.js";
+import { TargetCategory } from "./_ActivatableSkillTargetCategory.js";
+import { SkillTradition } from "./_Blessed.js";
+import { Enhancements } from "./_Enhancements.js";
+import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { LiturgyPrerequisites } from "./_Prerequisite.js";
+import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Ceremony
+ */
+export type Ceremony = {
+    /**
+     * The ceremony's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * In some cases, the target's Spirit or Toughness is applied as a penalty.
+     */
+    check_penalty?: SkillCheckPenalty;
+    /**
+     * Measurable parameters of a ceremony.
+     */
+    parameters: SlowPerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory;
+    /**
+     * The tradition(s) the ceremony is available for. Note that general aspects
+     * do not have an associated tradition and thus need to be defined in a
+     * special way.
+     * @minItems 1
+     */
+    traditions: SkillTradition[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    prerequisites?: LiturgyPrerequisites;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<CeremonyTranslation>;
+    enhancements?: Enhancements;
+};
+export type CeremonyTranslation = {
+    /**
+     * The name of the ceremony.
+     */
+    name: NonEmptyString;
+    /**
+     * A compressed name of the ceremony for use in small areas (e.g. on
+     * character sheet). Should only be defined if the `name` does not fit on
+     * character sheet.
+     */
+    name_compressed?: NonEmptyString;
+    /**
+     * The effect description may be either a plain text or a text that is
+     * divided by a list of effects for each quality level. It may also be a
+     * list for each two quality levels.
+     */
+    effect: Effect;
+    /**
+     * @deprecated
+     */
+    casting_time: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    cost: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    range: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    duration: {
+        full: string;
+        abbr: string;
+    };
+    /**
+     * @deprecated
+     */
+    target: string;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<Ceremony>;

package/lib/types/Ceremony.js

@@ -0,0 +1,12 @@
+/**
+ * @main Ceremony
+ */
+import { todo } from "../validation/builders/integrity.js";
+import { createSchemaValidator } from "../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../validation/filename.js";
+export const config = {
+    name: "Ceremony",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Ceremony"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/CombatTechnique_Close.d.ts

@@ -0,0 +1,73 @@
+/**
+ * @main CloseCombatTechnique
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { AttributeReference } from "./_SimpleReferences.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Close Combat Technique
+ */
+export type CloseCombatTechnique = {
+    /**
+     * The close combat technique's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Special rules for the combat technique that apply to all weapons in this
+     * category.
+     */
+    special: CloseCombatTechniqueSpecialRules;
+    /**
+     * The primary attribute(s).
+     * @minItems 1
+     * @maxItems 2
+     * @uniqueItems
+     */
+    primary_attribute: AttributeReference[];
+    /**
+     * The *Breaking Point Rating* of the respective combat technique.
+     * @integer
+     * @minimum 1
+     */
+    breaking_point_rating: number;
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<CloseCombatTechniqueTranslation>;
+};
+/**
+ * Special rules for the combat technique that apply to all weapons in this
+ * category.
+ */
+export type CloseCombatTechniqueSpecialRules = {
+    /**
+     * Is parrying possible with this combat technique?
+     */
+    can_parry: boolean;
+    has_damage_threshold: boolean;
+    has_reach: boolean;
+    has_length: boolean;
+    has_shield_size: boolean;
+};
+export type CloseCombatTechniqueTranslation = {
+    /**
+     * The name of the condition.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * Additional rules for the condition, if applicable.
+     * @markdown
+     * @minLength 1
+     */
+    special?: string;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<CloseCombatTechnique>;

package/lib/types/CombatTechnique_Close.js

@@ -0,0 +1,12 @@
+/**
+ * @main CloseCombatTechnique
+ */
+import { todo } from "../validation/builders/integrity.js";
+import { createSchemaValidator } from "../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../validation/filename.js";
+export const config = {
+    name: "CloseCombatTechnique",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("CloseCombatTechnique"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/CombatTechnique_Ranged.d.ts

@@ -0,0 +1,66 @@
+/**
+ * @main RangedCombatTechnique
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { AttributeReference } from "./_SimpleReferences.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Ranged Combat Technique
+ */
+export type RangedCombatTechnique = {
+    /**
+     * The ranged combat technique's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Special rules for the combat technique that apply to all weapons in this
+     * category.
+     */
+    special: RangedCombatTechniqueSpecialRules;
+    /**
+     * The primary attribute(s).
+     * @minItems 1
+     * @maxItems 2
+     * @uniqueItems
+     */
+    primary_attribute: AttributeReference[];
+    /**
+     * The *Breaking Point Rating* of the respective combat technique.
+     * @integer
+     * @minimum 1
+     */
+    breaking_point_rating: number;
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<RangedCombatTechniqueTranslation>;
+};
+/**
+ * Special rules for the combat technique that apply to all weapons in this
+ * category.
+ */
+export type RangedCombatTechniqueSpecialRules = {
+    has_ammunition: boolean;
+};
+export type RangedCombatTechniqueTranslation = {
+    /**
+     * The name of the condition.
+     * @minLength 1
+     */
+    name: string;
+    /**
+     * Additional rules for the condition, if applicable.
+     * @markdown
+     * @minLength 1
+     */
+    special?: string;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<RangedCombatTechnique>;

package/lib/types/CombatTechnique_Ranged.js

@@ -0,0 +1,12 @@
+/**
+ * @main RangedCombatTechnique
+ */
+import { todo } from "../validation/builders/integrity.js";
+import { createSchemaValidator } from "../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../validation/filename.js";
+export const config = {
+    name: "RangedCombatTechnique",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("RangedCombatTechnique"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/Condition.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @main Condition
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "./_NonEmptyString.js";
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Condition
+ */
+export type Condition = {
+    /**
+     * The condition's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ConditionTranslation>;
+};
+export type ConditionTranslation = {
+    /**
+     * The condition's name.
+     */
+    name: NonEmptyString;
+    /**
+     * Additional rules for the condition, if applicable.
+     */
+    rules?: NonEmptyMarkdown;
+    /**
+     * The effects for level 1 to 4.
+     */
+    effects: [NonEmptyMarkdown, NonEmptyMarkdown, NonEmptyMarkdown, NonEmptyMarkdown];
+    errata?: Errata;
+};
+export declare const config: TypeConfig<Condition>;

package/lib/types/Condition.js

@@ -0,0 +1,12 @@
+/**
+ * @main Condition
+ */
+import { todo } from "../validation/builders/integrity.js";
+import { createSchemaValidator } from "../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../validation/filename.js";
+export const config = {
+    name: "Condition",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Condition"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/Continent.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main Continent
+ */
+import { TypeConfig } from "../typeConfig.js";
+import { LocaleMap } from "./_LocaleMap.js";
+/**
+ * Continents are mostly referenced to in languages and scripts that occur on a
+ * specific continent.
+ * @title Continent
+ */
+export type Continent = {
+    /**
+     * The continent's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ContinentTranslation>;
+};
+export type ContinentTranslation = {
+    /**
+     * The continent name.
+     * @minLength 1
+     */
+    name: string;
+};
+export declare const config: TypeConfig<Continent>;

package/lib/types/Continent.js

@@ -0,0 +1,12 @@
+/**
+ * @main Continent
+ */
+import { todo } from "../validation/builders/integrity.js";
+import { createSchemaValidator } from "../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../validation/filename.js";
+export const config = {
+    name: "Continent",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Continent"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};