optolith-database-schema 0.2.2 → 0.3.0

package/lib/types/_Prerequisite.d.ts

@@ -2,108 +2,104 @@
  * @title Prerequisites
  */
 import { AdvantageDisadvantagePrerequisiteGroup, AnimistPowerPrerequisiteGroup, ArcaneTraditionPrerequisiteGroup, DerivedCharacteristicPrerequisiteGroup, EnhancementPrerequisiteGroup, GeneralPrerequisiteGroup, GeodeRitualPrerequisiteGroup, InfluencePrerequisiteGroup, LanguagePrerequisiteGroup, LiturgyPrerequisiteGroup, PersonalityTraitPrerequisiteGroup, ProfessionPrerequisiteGroup, PublicationPrerequisiteGroup, SpellworkPrerequisiteGroup } from "./prerequisites/PrerequisiteGroups.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
- * @title Prerequisite Collection Types
+ * A prerequisite group has no influence on validation logic. It serves as a
+ * single unit for displaying purposes, where the source uses a prerequisites
+ * item that cannot be represented as a single prerequisite.
  */
-declare namespace PrerequisiteCollection {
+export declare type PrerequisiteGroup<T> = {
     /**
-     * A prerequisite group has no influence on validation logic. It serves as a
-     * single unit for displaying purposes, where the source uses a prerequisites
-     * item that cannot be represented as a single prerequisite.
+     * @minItems 2
      */
-    export type Group<T> = {
-        tag: "Group";
-        /**
-         * @minItems 2
-         */
-        list: T[];
-        /**
-         * All translations for the entry, identified by IETF language tag (BCP47).
-         * @minProperties 1
-         */
-        translations: {
-            /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-             * @minLength 1
-             */
-            [localeId: string]: string;
-        };
-    };
-    type SingleAndGrouped<T> = T | Group<T>;
-    export type Plain<T> = {
-        tag: "Plain";
-        /**
-         * @minItems 1
-         */
-        list: SingleAndGrouped<T>[];
-    };
-    export type ByLevel<T> = Plain<T> | {
-        tag: "ByLevel";
-        /**
-         * @minItems 1
-         */
-        list: {
-            /**
-             * @integer
-             * @minimum 1
-             */
-            level: number;
-            /**
-             * @minItems 1
-             */
-            prerequisites: SingleAndGrouped<T>[];
-        }[];
-    };
-    export {};
-}
-export declare type DerivedCharacteristicPrerequisites = PrerequisiteCollection.Plain<DerivedCharacteristicPrerequisiteGroup>;
-export declare type PublicationPrerequisites = PrerequisiteCollection.Plain<PublicationPrerequisiteGroup>;
+    list: T[];
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<NonEmptyString>;
+};
+export declare type PrerequisiteSingleOrGroup<T> = T | {
+    tag: "Group";
+    group: PrerequisiteGroup<T>;
+};
+/**
+ * @minItems 1
+ */
+export declare type PlainPrerequisites<T> = PrerequisiteSingleOrGroup<T>[];
+/**
+ * @minItems 1
+ */
+export declare type PrerequisitesForLevels<T> = PrerequisitesForLevel<T>[];
+export declare type PrerequisitesForLevel<T> = {
+    /**
+     * @integer
+     * @minimum 1
+     */
+    level: number;
+    /**
+     * @minItems 1
+     */
+    prerequisites: PrerequisiteSingleOrGroup<T>[];
+};
+export declare type SimplePrerequisites<T> = {
+    tag: "Plain";
+    plain: PlainPrerequisites<T>;
+};
+export declare type PrerequisitesByLevel<T> = {
+    tag: "Plain";
+    plain: PlainPrerequisites<T>;
+} | {
+    tag: "ByLevel";
+    by_level: PrerequisitesForLevels<T>[];
+};
+export declare type DerivedCharacteristicPrerequisites = SimplePrerequisites<DerivedCharacteristicPrerequisiteGroup>;
+export declare type PublicationPrerequisites = SimplePrerequisites<PublicationPrerequisiteGroup>;
 /**
  * @title General Prerequisites
  */
-export declare type GeneralPrerequisites = PrerequisiteCollection.ByLevel<GeneralPrerequisiteGroup>;
+export declare type GeneralPrerequisites = PrerequisitesByLevel<GeneralPrerequisiteGroup>;
 /**
  * @title Profession Prerequisites
  */
-export declare type ProfessionPrerequisites = PrerequisiteCollection.Plain<ProfessionPrerequisiteGroup>;
+export declare type ProfessionPrerequisites = SimplePrerequisites<ProfessionPrerequisiteGroup>;
 /**
  * @title Advantage/Disadvantage Prerequisites
  */
-export declare type AdvantageDisadvantagePrerequisites = PrerequisiteCollection.ByLevel<AdvantageDisadvantagePrerequisiteGroup>;
+export declare type AdvantageDisadvantagePrerequisites = PrerequisitesByLevel<AdvantageDisadvantagePrerequisiteGroup>;
 /**
  * @title Arcane Tradition Prerequisites
  */
-export declare type ArcaneTraditionPrerequisites = PrerequisiteCollection.Plain<ArcaneTraditionPrerequisiteGroup>;
+export declare type ArcaneTraditionPrerequisites = SimplePrerequisites<ArcaneTraditionPrerequisiteGroup>;
 /**
  * @title Personality Trait Prerequisites
  */
-export declare type PersonalityTraitPrerequisites = PrerequisiteCollection.Plain<PersonalityTraitPrerequisiteGroup>;
+export declare type PersonalityTraitPrerequisites = SimplePrerequisites<PersonalityTraitPrerequisiteGroup>;
 /**
  * @title Spellwork Prerequisites
  */
-export declare type SpellworkPrerequisites = PrerequisiteCollection.Plain<SpellworkPrerequisiteGroup>;
+export declare type SpellworkPrerequisites = SimplePrerequisites<SpellworkPrerequisiteGroup>;
 /**
  * @title Liturgy Prerequisites
  */
-export declare type LiturgyPrerequisites = PrerequisiteCollection.Plain<LiturgyPrerequisiteGroup>;
+export declare type LiturgyPrerequisites = SimplePrerequisites<LiturgyPrerequisiteGroup>;
 /**
  * @title Influence Prerequisites
  */
-export declare type InfluencePrerequisites = PrerequisiteCollection.Plain<InfluencePrerequisiteGroup>;
+export declare type InfluencePrerequisites = SimplePrerequisites<InfluencePrerequisiteGroup>;
 /**
  * @title Language Prerequisites
  */
-export declare type LanguagePrerequisites = PrerequisiteCollection.ByLevel<LanguagePrerequisiteGroup>;
+export declare type LanguagePrerequisites = PrerequisitesByLevel<LanguagePrerequisiteGroup>;
 /**
  * @title Animist Power Prerequisites
  */
-export declare type AnimistPowerPrerequisites = PrerequisiteCollection.Plain<AnimistPowerPrerequisiteGroup>;
+export declare type AnimistPowerPrerequisites = SimplePrerequisites<AnimistPowerPrerequisiteGroup>;
 /**
  * @title Geode Ritual Prerequisites
  */
-export declare type GeodeRitualPrerequisites = PrerequisiteCollection.Plain<GeodeRitualPrerequisiteGroup>;
+export declare type GeodeRitualPrerequisites = SimplePrerequisites<GeodeRitualPrerequisiteGroup>;
 /**
  * @title Enhancement Prerequisites
  */
-export declare type EnhancementPrerequisites = PrerequisiteCollection.Plain<EnhancementPrerequisiteGroup>;
-export {};
+export declare type EnhancementPrerequisites = SimplePrerequisites<EnhancementPrerequisiteGroup>;

package/lib/types/_ResponsiveText.d.ts

@@ -0,0 +1,54 @@
+import { NonEmptyString } from "./_NonEmptyString.js";
+/**
+ * A text from the source that can be also displayed in small areas using a
+ * compressed version.
+ */
+export declare type ResponsiveText = {
+    /**
+     * The full text from the source.
+     */
+    full: NonEmptyString;
+    /**
+     * A compressed text for use in small areas (e.g. on character sheet).
+     */
+    compressed: NonEmptyString;
+};
+/**
+ * A text from the source that can be also displayed in small areas using a
+ * compressed version. It is used as a replacement for a generated text while
+ * the generated text is still provided and should be used.
+ */
+export declare type ResponsiveTextReplace = {
+    /**
+     * The full replacement string. It must contain `$1`, which is going to be
+     * replaced with the generated string, so additional information can be
+     * provided without duplicating concrete numeric values.
+     * @minLength 1
+     * @pattern \$1
+     */
+    default: string;
+    /**
+     * A compressed replacement string for use in small areas (e.g. on character
+     * sheet). It must contain `$1`, which is going to be replaced with the
+     * generated string, so additional information can be provided without
+     * duplicating concrete numeric values.
+     * @minLength 1
+     * @pattern \$1
+     */
+    compressed: string;
+};
+/**
+ * A text from the source that can be also displayed in small areas using a
+ * compressed version, if available.
+ */
+export declare type ResponsiveTextOptional = {
+    /**
+     * The full text from the source.
+     */
+    full: NonEmptyString;
+    /**
+     * A compressed text for use in small areas (e.g. on character sheet). If this
+     * is not present, it should not appear in those areas.
+     */
+    compressed?: NonEmptyString;
+};

package/lib/types/_ResponsiveText.js

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

package/lib/types/_SimpleReferences.d.ts

@@ -0,0 +1,334 @@
+import { CombatTechniqueIdentifier } from "./_Identifier.js";
+export declare type FocusRuleSubjectReference = {
+    /**
+     * The focus rule subject's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type RaceReference = {
+    /**
+     * The race's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type CultureReference = {
+    /**
+     * The culture's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type ProfessionReference = {
+    /**
+     * The profession's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type ProfessionVariantReference = {
+    /**
+     * The profession variant's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type AttributeReference = {
+    /**
+     * The attribute's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 8
+     */
+    id: number;
+};
+export declare type SkillReference = {
+    /**
+     * The skill's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type SkillGroupReference = {
+    /**
+     * The skill group's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 5
+     */
+    id: number;
+};
+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;
+};
+export declare type RangedCombatTechniqueReference = {
+    /**
+     * The ranged combat technique's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type MagicalTraditionReference = {
+    /**
+     * The magical tradition's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type CantripReference = {
+    /**
+     * The cantrip's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type SpellReference = {
+    /**
+     * The spell's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type RitualReference = {
+    /**
+     * The ritual's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type PropertyReference = {
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type BlessedTraditionReference = {
+    /**
+     * The blessed tradition's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type BlessingReference = {
+    /**
+     * The blessing's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type LiturgicalChantReference = {
+    /**
+     * The liturgical chant's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type CeremonyReference = {
+    /**
+     * The ceremony's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type AspectReference = {
+    /**
+     * The aspect's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+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;
+};
+export declare type LanguageReference = {
+    /**
+     * The language's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type ScriptReference = {
+    /**
+     * The script's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type SocialStatusReference = {
+    /**
+     * The social status's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 5
+     */
+    id: number;
+};
+export declare type CurriculumReference = {
+    /**
+     * The institution's curriculum's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type GuidelineReference = {
+    /**
+     * The institution's guideline's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    id: number;
+};
+export declare type AnimalTypeReference = {
+    /**
+     * The animal type's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type TargetCategoryReference = {
+    /**
+     * The target category's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 24
+     */
+    id: number;
+};
+export declare type PatronCategoryReference = {
+    /**
+     * The patron category's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type PersonalityTraitReference = {
+    /**
+     * The personality trait's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type HairColorReference = {
+    /**
+     * The hair color's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type EyeColorReference = {
+    /**
+     * The hair color's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type PactCategoryReference = {
+    /**
+     * The pact category's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type PactDomainReference = {
+    /**
+     * The domain's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type PatronReference = {
+    /**
+     * The patron's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type AnimistTribeReference = {
+    /**
+     * The tribe's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    id: number;
+};
+export declare type ElementReference = {
+    /**
+     * The element's identifier.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    id: number;
+};
+export declare type WeaponReference = {
+    /**
+     * The weapon's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};
+export declare type ArmorReference = {
+    /**
+     * The armor's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+};

package/lib/types/_SimpleReferences.js

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

package/lib/types/_SkillCheck.d.ts

@@ -1,17 +1,13 @@
+import { AttributeReference } from "./_SimpleReferences.js";
 /**
  * The attributes' identifiers of the skill check.
  * @title Skill Check
  */
-export declare type SkillCheck = [Attribute, Attribute, Attribute];
-declare type Attribute = {
-    /**
-     * The attribute's identifier.
-     * @integer
-     * @minimum 1
-     * @maximum 8
-     */
-    id: number;
-};
+export declare type SkillCheck = [
+    AttributeReference,
+    AttributeReference,
+    AttributeReference
+];
 /**
  * A specific value that represents a penalty for the associated skill check.
  * @title Skill Check Penalty
@@ -25,4 +21,3 @@ export declare type SkillCheckPenalty = {
 } | {
     tag: "SPI/TOU";
 };
-export {};

package/lib/types/_Spellwork.d.ts

@@ -0,0 +1,17 @@
+import { MagicalTraditionIdentifier } from "./_Identifier.js";
+/**
+ * The tradition(s) the ritual is available for. It may be *generally*
+ * available to all traditions or it may be only familiar in specific
+ * traditions.
+ */
+export declare type Traditions = {
+    tag: "General";
+} | {
+    tag: "Specific";
+    specific: SpecificTraditions;
+};
+/**
+ * A list of specific traditions.
+ * @minItems 1
+ */
+export declare type SpecificTraditions = MagicalTraditionIdentifier[];

package/lib/types/_Spellwork.js

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

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

@@ -1,6 +1,9 @@
 /**
  * @main EquipmentPackage
  */
+import { EquipmentIdentifier } from "../_Identifier.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
 /**
  * @title Equipment Package
  */
@@ -17,36 +20,29 @@ export declare type EquipmentPackage = {
      * is included in the package.
      * @minItems 2
      */
-    items: {
-        /**
-         * The item's identifier.
-         * @integer
-         * @minimum 1
-         */
-        id: number;
-        /**
-         * The number of how often the item is included in the package.
-         * @integer
-         * @minimum 2
-         * @default 1
-         */
-        number?: number;
-    }[];
+    items: EquipmentPackageItem[];
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The name of the equipment package.
-             * @minLength 1
-             */
-            name: string;
-        };
-    };
+    translations: LocaleMap<EquipmentPackageTranslation>;
+};
+export declare type EquipmentPackageItem = {
+    /**
+     * The item's identifier.
+     */
+    id: EquipmentIdentifier;
+    /**
+     * The number of how often the item is included in the package.
+     * @integer
+     * @minimum 2
+     * @default 1
+     */
+    number?: number;
+};
+export declare type EquipmentPackageTranslation = {
+    /**
+     * The name of the equipment package.
+     */
+    name: NonEmptyString;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<EquipmentPackage>;

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

@@ -0,0 +1,6 @@
+/**
+ * @main Alchemicum
+ */
+import { DefaultItem } from "./_Item.js";
+export declare type Alchemicum = DefaultItem;
+export declare const validateSchema: import("../../../validation/schema.js").TypeValidator<DefaultItem>;

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

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