optolith-database-schema 0.4.0 → 0.5.0

package/lib/types/_SimpleReferences.d.ts

@@ -1,334 +1,131 @@
-import { CombatTechniqueIdentifier } from "./_Identifier.js";
+import { AdvantageIdentifier, AnimalTypeIdentifier, AnimistTribeIdentifier, ArmorIdentifier, AspectIdentifier, AttributeIdentifier, BlessedTraditionIdentifier, BlessingIdentifier, CantripIdentifier, CeremonyIdentifier, CloseCombatTechniqueIdentifier, CultureIdentifier, CurriculumIdentifier, DisadvantageIdentifier, ElementIdentifier, EyeColorIdentifier, GuidelineIdentifier, HairColorIdentifier, LanguageIdentifier, LiturgicalChantIdentifier, MagicalTraditionIdentifier, PactCategoryIdentifier, PactDomainIdentifier, PatronCategoryIdentifier, PatronIdentifier, PersonalityTraitIdentifier, ProfessionIdentifier, ProfessionVariantIdentifier, PropertyIdentifier, RaceIdentifier, RangedCombatTechniqueIdentifier, RitualIdentifier, ScriptIdentifier, SkillGroupIdentifier, SkillIdentifier, SocialStatusIdentifier, SpellIdentifier, SubjectIdentifier, TargetCategoryIdentifier, WeaponIdentifier } from "./_Identifier.js";
+import { CombatTechniqueIdentifier, SpellworkIdentifier } from "./_IdentifierGroup.js";
 export declare type FocusRuleSubjectReference = {
-    /**
-     * The focus rule subject's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: SubjectIdentifier;
 };
 export declare type RaceReference = {
-    /**
-     * The race's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: RaceIdentifier;
 };
 export declare type CultureReference = {
-    /**
-     * The culture's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: CultureIdentifier;
 };
 export declare type ProfessionReference = {
-    /**
-     * The profession's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: ProfessionIdentifier;
 };
 export declare type ProfessionVariantReference = {
-    /**
-     * The profession variant's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: ProfessionVariantIdentifier;
 };
 export declare type AttributeReference = {
-    /**
-     * The attribute's identifier.
-     * @integer
-     * @minimum 1
-     * @maximum 8
-     */
-    id: number;
+    id: AttributeIdentifier;
 };
 export declare type SkillReference = {
-    /**
-     * The skill's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: SkillIdentifier;
 };
 export declare type SkillGroupReference = {
-    /**
-     * The skill group's identifier.
-     * @integer
-     * @minimum 1
-     * @maximum 5
-     */
-    id: number;
+    id: SkillGroupIdentifier;
 };
 export declare type CombatTechniqueReference = {
-    /**
-     * The combat technique's identifier.
-     */
     id: CombatTechniqueIdentifier;
 };
 export declare type CloseCombatTechniqueReference = {
-    /**
-     * The close combat technique's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: CloseCombatTechniqueIdentifier;
 };
 export declare type RangedCombatTechniqueReference = {
-    /**
-     * The ranged combat technique's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: RangedCombatTechniqueIdentifier;
 };
 export declare type MagicalTraditionReference = {
-    /**
-     * The magical tradition's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: MagicalTraditionIdentifier;
 };
 export declare type CantripReference = {
-    /**
-     * The cantrip's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: CantripIdentifier;
 };
 export declare type SpellReference = {
-    /**
-     * The spell's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: SpellIdentifier;
 };
 export declare type RitualReference = {
-    /**
-     * The ritual's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: RitualIdentifier;
+};
+export declare type SpellworkReference = {
+    id: SpellworkIdentifier;
 };
 export declare type PropertyReference = {
-    /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: PropertyIdentifier;
 };
 export declare type BlessedTraditionReference = {
-    /**
-     * The blessed tradition's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: BlessedTraditionIdentifier;
 };
 export declare type BlessingReference = {
-    /**
-     * The blessing's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: BlessingIdentifier;
 };
 export declare type LiturgicalChantReference = {
-    /**
-     * The liturgical chant's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: LiturgicalChantIdentifier;
 };
 export declare type CeremonyReference = {
-    /**
-     * The ceremony's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: CeremonyIdentifier;
 };
 export declare type AspectReference = {
-    /**
-     * The aspect's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: AspectIdentifier;
 };
 export declare type AdvantageReference = {
-    /**
-     * The advantage's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-};
-export declare type AdvancedSpecialAbilityReference = {
-    /**
-     * The advanced special ability's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: AdvantageIdentifier;
+};
+export declare type DisadvantageReference = {
+    id: DisadvantageIdentifier;
+};
+export declare type AdvancedSpecialAbilityReference<Identifier> = {
+    id: Identifier;
 };
 export declare type LanguageReference = {
-    /**
-     * The language's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: LanguageIdentifier;
 };
 export declare type ScriptReference = {
-    /**
-     * The script's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: ScriptIdentifier;
 };
 export declare type SocialStatusReference = {
-    /**
-     * The social status's identifier.
-     * @integer
-     * @minimum 1
-     * @maximum 5
-     */
-    id: number;
+    id: SocialStatusIdentifier;
 };
 export declare type CurriculumReference = {
-    /**
-     * The institution's curriculum's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: CurriculumIdentifier;
 };
 export declare type GuidelineReference = {
-    /**
-     * The institution's guideline's identifier.
-     * @integer
-     * @minimum 1
-     * @maximum 6
-     */
-    id: number;
+    id: GuidelineIdentifier;
 };
 export declare type AnimalTypeReference = {
-    /**
-     * The animal type's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: AnimalTypeIdentifier;
 };
 export declare type TargetCategoryReference = {
-    /**
-     * The target category's identifier.
-     * @integer
-     * @minimum 1
-     * @maximum 24
-     */
-    id: number;
+    id: TargetCategoryIdentifier;
 };
 export declare type PatronCategoryReference = {
-    /**
-     * The patron category's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: PatronCategoryIdentifier;
 };
 export declare type PersonalityTraitReference = {
-    /**
-     * The personality trait's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: PersonalityTraitIdentifier;
 };
 export declare type HairColorReference = {
-    /**
-     * The hair color's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: HairColorIdentifier;
 };
 export declare type EyeColorReference = {
-    /**
-     * The hair color's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: EyeColorIdentifier;
 };
 export declare type PactCategoryReference = {
-    /**
-     * The pact category's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: PactCategoryIdentifier;
 };
 export declare type PactDomainReference = {
-    /**
-     * The domain's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: PactDomainIdentifier;
 };
 export declare type PatronReference = {
-    /**
-     * The patron's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: PatronIdentifier;
 };
 export declare type AnimistTribeReference = {
-    /**
-     * The tribe's identifier.
-     * @integer
-     * @minimum 1
-     * @maximum 6
-     */
-    id: number;
+    id: AnimistTribeIdentifier;
 };
 export declare type ElementReference = {
-    /**
-     * The element's identifier.
-     * @integer
-     * @minimum 1
-     * @maximum 6
-     */
-    id: number;
+    id: ElementIdentifier;
 };
 export declare type WeaponReference = {
-    /**
-     * The weapon's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: WeaponIdentifier;
 };
 export declare type ArmorReference = {
-    /**
-     * The armor's identifier.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
+    id: ArmorIdentifier;
 };

package/lib/types/equipment/EquipmentPackage.d.ts

@@ -1,7 +1,7 @@
 /**
  * @main EquipmentPackage
  */
-import { EquipmentIdentifier } from "../_Identifier.js";
+import { EquipmentIdentifier } from "../_IdentifierGroup.js";
 import { LocaleMap } from "../_LocaleMap.js";
 import { NonEmptyString } from "../_NonEmptyString.js";
 /**

package/lib/types/equipment/item/Elixir.d.ts

@@ -0,0 +1,75 @@
+/**
+ * @main Elixir
+ */
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { AlternativeName } from "../../_AlternativeNames.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { LaboratoryLevel, RecipeTradeSecret } from "./_Herbary.js";
+export declare type Elixir = {
+    /**
+     * The elixir's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The cost per ingredient level in silverthalers.
+     */
+    cost_per_ingredient_level: number;
+    /**
+     * The laboratory level needed to brew the elixir.
+     */
+    laboratory: LaboratoryLevel;
+    /**
+     * The brewing difficulty, which represents the challenge of creating an
+     * elixir.
+     * @integer
+     */
+    brewing_difficulty: number;
+    /**
+     * AP value and prerequisites of the elixir recipe’s trade secret.
+     */
+    trade_secret: RecipeTradeSecret;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ElixirTranslation>;
+};
+export declare type ElixirTranslation = {
+    /**
+     * The name of the elixir.
+     */
+    name: NonEmptyString;
+    /**
+     * A list of alternative names.
+     * @minItems 1
+     */
+    alternative_names?: AlternativeName[];
+    /**
+     * A list of common ingredients.
+     * @minItems 1
+     * @uniqueItems
+     */
+    common_ingredients: NonEmptyString[];
+    /**
+     * Prerequsites for the brewing process, if any.
+     */
+    brewing_process_prerequisites?: NonEmptyMarkdown;
+    /**
+     * The list of effects for each quality level. The first element
+     * represents QL 1, the second element QL 2, and so on.
+     */
+    quality_levels: [
+        NonEmptyMarkdown,
+        NonEmptyMarkdown,
+        NonEmptyMarkdown,
+        NonEmptyMarkdown,
+        NonEmptyMarkdown,
+        NonEmptyMarkdown
+    ];
+    errata?: Errata;
+};
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<Elixir>;

package/lib/types/equipment/item/Elixir.js

@@ -0,0 +1,5 @@
+/**
+ * @main Elixir
+ */
+import { validateSchemaCreator } from "../../../validation/schema.js";
+export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/equipment/item/EquipmentOfBlessedOnes.d.ts

@@ -18,7 +18,7 @@ export declare type EquipmentOfBlessedOnes = {
     /**
      * The deity associated with the equipment item.
      */
-    associated_tradition: BlessedTraditionReference;
+    associated_tradition: BlessedTraditionReference[];
     src: PublicationRefs;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).