optolith-database-schema 0.1.22 → 0.1.25

package/CHANGELOG.md

@@ -2,6 +2,34 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.1.25](https://github.com/elyukai/optolith-database-schema/compare/v0.1.24...v0.1.25) (2022-03-23)
+
+
+### Features
+
+* add missing json schema definitions as placeholders ([28d2c6f](https://github.com/elyukai/optolith-database-schema/commit/28d2c6f2758fc090b4854eb8656613932841b252))
+
+### [0.1.24](https://github.com/elyukai/optolith-database-schema/compare/v0.1.23...v0.1.24) (2022-03-23)
+
+
+### Features
+
+* add curriculum references and name additions ([468f96c](https://github.com/elyukai/optolith-database-schema/commit/468f96ce9af3b6f3135f959c9dc5d2646ea46e41))
+
+### [0.1.23](https://github.com/elyukai/optolith-database-schema/compare/v0.1.22...v0.1.23) (2022-03-23)
+
+
+### Features
+
+* church influences ([81b96c4](https://github.com/elyukai/optolith-database-schema/commit/81b96c49bb365527bbbededc02afb227b80bff98))
+* core rules ([3be09e3](https://github.com/elyukai/optolith-database-schema/commit/3be09e3707a198ff0697ccf9325e83037ebd6e32))
+* equipment packages ([8fc29ef](https://github.com/elyukai/optolith-database-schema/commit/8fc29ef67ab8679f95234e30e19a49486a05b6fc))
+* magical tradition placeholders# ([bfa1e18](https://github.com/elyukai/optolith-database-schema/commit/bfa1e18195b847925a8fd8d3e56b8ff130d8a584))
+* profession male/female names and groups ([a38b0f4](https://github.com/elyukai/optolith-database-schema/commit/a38b0f4401444318b57bb163eb7192dd58b83d3d))
+* talismans ([22a1a4f](https://github.com/elyukai/optolith-database-schema/commit/22a1a4f00985f70dba7d5b38f2f583263cf0389d))
+* talismans support multiple traditions ([480779e](https://github.com/elyukai/optolith-database-schema/commit/480779e9c41efc6e5685b52cc45339bb04e94c97))
+* update validation config to include latest new definitions ([bb9d856](https://github.com/elyukai/optolith-database-schema/commit/bb9d85685edee1eb3ac30589eb25e09c02bc36da))
+
 ### [0.1.22](https://github.com/elyukai/optolith-database-schema/compare/v0.1.21...v0.1.22) (2022-03-23)
 
 

package/lib/config.d.ts

@@ -14,11 +14,13 @@ import { Culture } from "./types/Culture.js";
 import { DerivedCharacteristic } from "./types/DerivedCharacteristic.js";
 import { Disadvantage } from "./types/Disadvantage.js";
 import { Element } from "./types/Element.js";
+import { EquipmentPackage } from "./types/equipment/EquipmentPackage.js";
 import { ExperienceLevel } from "./types/ExperienceLevel.js";
 import { EyeColor } from "./types/EyeColor.js";
 import { FamiliarsTrick } from "./types/FamiliarsTrick.js";
 import { AnimalType } from "./types/FamiliarsTrick_AnimalType.js";
 import { HairColor } from "./types/HairColor.js";
+import { Kirchenpraegung } from "./types/Kirchenpraegung.js";
 import { Curriculum } from "./types/Lessons_Curriculum.js";
 import { Guideline } from "./types/Lessons_Guideline.js";
 import { LiturgicalChant } from "./types/LiturgicalChant.js";
@@ -34,15 +36,18 @@ import { MagicalDance } from "./types/magicalActions/MagicalDance.js";
 import { MagicalMelody } from "./types/magicalActions/MagicalMelody.js";
 import { MagicalRune } from "./types/magicalActions/MagicalRune.js";
 import { ZibiljaRitual } from "./types/magicalActions/ZibiljaRitual.js";
+import { MagicalTraditionPlaceholder } from "./types/MagicalTraditionPlaceholder.js";
 import { MetaCondition } from "./types/MetaCondition.js";
 import { PactCategory } from "./types/PactCategory.js";
 import { Patron } from "./types/Patron.js";
 import { PatronCategory } from "./types/PatronCategory.js";
 import { PersonalityTrait } from "./types/PersonalityTrait.js";
+import { Profession } from "./types/Profession.js";
 import { Property } from "./types/Property.js";
 import { Race } from "./types/Race.js";
 import { Region } from "./types/Region.js";
 import { Ritual } from "./types/Ritual.js";
+import { CoreRule } from "./types/rule/CoreRule.js";
 import { FocusRule } from "./types/rule/FocusRule.js";
 import { Subject } from "./types/rule/FocusRule_Subject.js";
 import { OptionalRule } from "./types/rule/OptionalRule.js";
@@ -87,6 +92,7 @@ import { VampiricGift } from "./types/specialAbility/VampiricGift.js";
 import { Vision } from "./types/specialAbility/Vision.js";
 import { Spell } from "./types/Spell.js";
 import { State } from "./types/State.js";
+import { Talisman } from "./types/Talisman.js";
 import { TargetCategory } from "./types/TargetCategory.js";
 import { ArcaneOrbEnchantment } from "./types/traditionArtifacts/ArcaneOrbEnchantment.js";
 import { AttireEnchantment } from "./types/traditionArtifacts/AttireEnchantment.js";
@@ -145,6 +151,7 @@ export declare type TypeMap = {
     commandSpecialAbilities: CommandSpecialAbility;
     conditions: Condition;
     continents: Continent;
+    coreRules: CoreRule;
     cultures: Culture;
     curses: Curse;
     daggerRituals: DaggerRitual;
@@ -153,6 +160,7 @@ export declare type TypeMap = {
     dominationRituals: DominationRitual;
     elements: Element;
     elvenMagicalSongs: ElvenMagicalSong;
+    equipmentPackages: EquipmentPackage;
     experienceLevels: ExperienceLevel;
     eyeColors: EyeColor;
     familiarSpecialAbilities: FamiliarSpecialAbility;
@@ -169,6 +177,7 @@ export declare type TypeMap = {
     instrumentEnchantments: InstrumentEnchantment;
     jesterTricks: JesterTrick;
     karmaSpecialAbilities: KarmaSpecialAbility;
+    kirchenpraegungen: Kirchenpraegung;
     krallenkettenzauber: Krallenkettenzauber;
     languages: Language;
     lessonsCurricula: Curriculum;
@@ -182,6 +191,7 @@ export declare type TypeMap = {
     magicalRunes: MagicalRune;
     magicalSpecialAbilities: MagicalSpecialAbility;
     magicalTraditions: MagicalTradition;
+    magicalTraditionPlaceholders: MagicalTraditionPlaceholder;
     magicStyleSpecialAbilities: MagicStyleSpecialAbility;
     metaConditions: MetaCondition;
     optionalRules: OptionalRule;
@@ -191,6 +201,7 @@ export declare type TypeMap = {
     patronCategories: PatronCategory;
     patrons: Patron;
     personalityTraits: PersonalityTrait;
+    professions: Profession;
     properties: Property;
     protectiveWardingCircleSpecialAbilities: ProtectiveWardingCircleSpecialAbility;
     publications: Publication;
@@ -216,6 +227,7 @@ export declare type TypeMap = {
     staffEnchantments: StaffEnchantment;
     states: State;
     targetCategories: TargetCategory;
+    talismans: Talisman;
     toyEnchantments: ToyEnchantment;
     tradeSecrets: TradeSecret;
     trinkhornzauber: Trinkhornzauber;

package/lib/config.js

@@ -14,11 +14,13 @@ import { validateSchema as validateCultureSchema } from "./types/Culture.js";
 import { validateSchema as validateDerivedCharacteristicSchema } from "./types/DerivedCharacteristic.js";
 import { validateSchema as validateDisadvantageSchema } from "./types/Disadvantage.js";
 import { validateSchema as validateElementSchema } from "./types/Element.js";
+import { validateSchema as validateEquipmentPackageSchema } from "./types/equipment/EquipmentPackage.js";
 import { validateSchema as validateExperienceLevelSchema } from "./types/ExperienceLevel.js";
 import { validateSchema as validateEyeColorSchema } from "./types/EyeColor.js";
 import { validateSchema as validateFamiliarsTrickSchema } from "./types/FamiliarsTrick.js";
 import { validateSchema as validateAnimalTypeSchema } from "./types/FamiliarsTrick_AnimalType.js";
 import { validateSchema as validateHairColorSchema } from "./types/HairColor.js";
+import { validateSchema as validateKirchenpraegungSchema } from "./types/Kirchenpraegung.js";
 import { validateSchema as validateCurriculumSchema } from "./types/Lessons_Curriculum.js";
 import { validateSchema as validateGuidelineSchema } from "./types/Lessons_Guideline.js";
 import { validateSchema as validateLiturgicalChantSchema } from "./types/LiturgicalChant.js";
@@ -34,15 +36,18 @@ import { validateSchema as validateMagicalDanceSchema } from "./types/magicalAct
 import { validateSchema as validateMagicalMelodySchema } from "./types/magicalActions/MagicalMelody.js";
 import { validateSchema as validateMagicalRuneSchema } from "./types/magicalActions/MagicalRune.js";
 import { validateSchema as validateZibiljaRitualSchema } from "./types/magicalActions/ZibiljaRitual.js";
+import { validateSchema as validateMagicalTraditionPlaceholderSchema } from "./types/MagicalTraditionPlaceholder.js";
 import { validateSchema as validateMetaConditionSchema } from "./types/MetaCondition.js";
 import { validateSchema as validatePactCategorySchema } from "./types/PactCategory.js";
 import { validateSchema as validatePatronSchema } from "./types/Patron.js";
 import { validateSchema as validatePatronCategorySchema } from "./types/PatronCategory.js";
 import { validateSchema as validatePersonalityTraitSchema } from "./types/PersonalityTrait.js";
+import { validateSchema as validateProfessionSchema } from "./types/Profession.js";
 import { validateSchema as validatePropertySchema } from "./types/Property.js";
 import { validateSchema as validateRaceSchema } from "./types/Race.js";
 import { validateSchema as validateRegionSchema } from "./types/Region.js";
 import { validateSchema as validateRitualSchema } from "./types/Ritual.js";
+import { validateSchema as validateCoreRuleSchema } from "./types/rule/CoreRule.js";
 import { validateSchema as validateFocusRuleSchema } from "./types/rule/FocusRule.js";
 import { validateSchema as validateSubjectSchema } from "./types/rule/FocusRule_Subject.js";
 import { validateSchema as validateOptionalRuleSchema } from "./types/rule/OptionalRule.js";
@@ -87,6 +92,7 @@ import { validateSchema as validateVampiricGiftSchema } from "./types/specialAbi
 import { validateSchema as validateVisionSchema } from "./types/specialAbility/Vision.js";
 import { validateSchema as validateSpellSchema } from "./types/Spell.js";
 import { validateSchema as validateStateSchema } from "./types/State.js";
+import { validateSchema as validateTalismanSchema } from "./types/Talisman.js";
 import { validateSchema as validateTargetCategorySchema } from "./types/TargetCategory.js";
 import { validateSchema as validateArcaneOrbEnchantmentSchema } from "./types/traditionArtifacts/ArcaneOrbEnchantment.js";
 import { validateSchema as validateAttireEnchantmentSchema } from "./types/traditionArtifacts/AttireEnchantment.js";
@@ -144,6 +150,7 @@ export const typeValidatorMap = {
     commandSpecialAbilities: validateCommandSpecialAbilitySchema,
     conditions: validateConditionSchema,
     continents: validateContinentSchema,
+    coreRules: validateCoreRuleSchema,
     cultures: validateCultureSchema,
     curses: validateCurseSchema,
     daggerRituals: validateDaggerRitualSchema,
@@ -152,6 +159,7 @@ export const typeValidatorMap = {
     dominationRituals: validateDominationRitualSchema,
     elements: validateElementSchema,
     elvenMagicalSongs: validateElvenMagicalSongSchema,
+    equipmentPackages: validateEquipmentPackageSchema,
     experienceLevels: validateExperienceLevelSchema,
     eyeColors: validateEyeColorSchema,
     familiarSpecialAbilities: validateFamiliarSpecialAbilitySchema,
@@ -168,6 +176,7 @@ export const typeValidatorMap = {
     instrumentEnchantments: validateInstrumentEnchantmentSchema,
     jesterTricks: validateJesterTrickSchema,
     karmaSpecialAbilities: validateKarmaSpecialAbilitySchema,
+    kirchenpraegungen: validateKirchenpraegungSchema,
     krallenkettenzauber: validateKrallenkettenzauberSchema,
     languages: validateLanguageSchema,
     lessonsCurricula: validateCurriculumSchema,
@@ -181,6 +190,7 @@ export const typeValidatorMap = {
     magicalRunes: validateMagicalRuneSchema,
     magicalSpecialAbilities: validateMagicalSpecialAbilitySchema,
     magicalTraditions: validateMagicalTraditionSchema,
+    magicalTraditionPlaceholders: validateMagicalTraditionPlaceholderSchema,
     magicStyleSpecialAbilities: validateMagicStyleSpecialAbilitySchema,
     metaConditions: validateMetaConditionSchema,
     optionalRules: validateOptionalRuleSchema,
@@ -190,6 +200,7 @@ export const typeValidatorMap = {
     patronCategories: validatePatronCategorySchema,
     patrons: validatePatronSchema,
     personalityTraits: validatePersonalityTraitSchema,
+    professions: validateProfessionSchema,
     properties: validatePropertySchema,
     protectiveWardingCircleSpecialAbilities: validateProtectiveWardingCircleSpecialAbilitySchema,
     publications: validatePublicationSchema,
@@ -215,6 +226,7 @@ export const typeValidatorMap = {
     staffEnchantments: validateStaffEnchantmentSchema,
     states: validateStateSchema,
     targetCategories: validateTargetCategorySchema,
+    talismans: validateTalismanSchema,
     toyEnchantments: validateToyEnchantmentSchema,
     tradeSecrets: validateTradeSecretSchema,
     trinkhornzauber: validateTrinkhornzauberSchema,

package/lib/types/Kirchenpraegung.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @main Kirchenpraegung
+ */
+import { Influence } from "./_Influence.js";
+/**
+ * @title Kirchenprägung
+ */
+export declare type Kirchenpraegung = Influence;
+export declare const validateSchema: import("../validation/schema.js").TypeValidator<Influence>;

package/lib/types/Kirchenpraegung.js

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

package/lib/types/MagicalTraditionPlaceholder.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @main MagicalTraditionPlaceholder
+ */
+/**
+ * @title Magical Tradition Placeholder
+ */
+export declare type MagicalTraditionPlaceholder = {
+    /**
+     * The magical tradition placeholder's identifier. An unique, increasing
+     * integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * 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 magical tradition.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};
+export declare const validateSchema: import("../validation/schema.js").TypeValidator<MagicalTraditionPlaceholder>;

package/lib/types/MagicalTraditionPlaceholder.js

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

package/lib/types/Profession.d.ts

@@ -16,6 +16,21 @@ export declare type Profession = {
      * @minimum 1
      */
     id: number;
+    /**
+     * The profession group.
+     */
+    group: Group;
+    /**
+     * The curriculum/academy associated with this magical profession, if any.
+     */
+    curriculum?: {
+        /**
+         * The curriculum's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    };
     /**
      * A list of professions representing the same profession but with (slightly)
      * different stats. For example, there may be a profession in a regional
@@ -170,9 +185,13 @@ export declare type ProfessionRepresentationVariant = {
         [localeId: string]: {
             /**
              * Name of the basic profession.
-             * @minLength 1
              */
-            name: string;
+            name: Name;
+            /**
+             * A name addition of the profession. This will contain texts like name of
+             * the academy or the witch circle. It is enclosed in parenthesis.
+             */
+            specification?: Name;
             /**
              * Typical advantages for the profession.
              * @minLength 1
@@ -267,9 +286,8 @@ declare type ProfessionVariant = {
         [localeId: string]: {
             /**
              * Name of the profession variant.
-             * @minLength 1
              */
-            name: string;
+            name: Name;
         };
     };
 };
@@ -726,5 +744,40 @@ declare type SkillsOptions = {
      */
     ap_value: number;
 };
+/**
+ * The name of the profession that may have sex-specific names.
+ */
+declare type Name = NonEmptyString | {
+    /**
+     * The name from the source publication.
+     */
+    default: NonEmptyString;
+    /**
+     * The male name.
+     */
+    male: NonEmptyString;
+    /**
+     * The female name.
+     */
+    female: NonEmptyString;
+};
+declare type Group = {
+    tag: "Mundane";
+    sub: {
+        tag: "Profane";
+    } | {
+        tag: "Fighter";
+    } | {
+        tag: "Religious";
+    };
+} | {
+    tag: "Magical";
+} | {
+    tag: "Blessed";
+};
+/**
+ * @minLength 1
+ */
+declare type NonEmptyString = string;
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Profession>;
 export {};

package/lib/types/Talisman.d.ts

@@ -0,0 +1,89 @@
+/**
+ * @main Talisman
+ */
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Talisman
+ */
+export declare type Talisman = {
+    /**
+     * The talisman's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The tradition(s) the talisman belongs to.
+     * @minItems 1
+     */
+    tradition: {
+        /**
+         * The blessed traditions's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    }[];
+    /**
+     * The talisman type.
+     */
+    type: {
+        tag: "MainTalisman";
+    } | {
+        tag: "Talisman";
+    } | {
+        tag: "MinorTalisman";
+    } | {
+        tag: "Regalia";
+    } | {
+        tag: "PowerfulTalisman";
+    };
+    /**
+     * The AP value for the required trade secret.
+     * @integer
+     * @minimum 5
+     * @multipleOf 5
+     */
+    ap_value: number;
+    src: PublicationRefs;
+    /**
+     * 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 talisman.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description.
+             * @markdown
+             * @minLength 1
+             */
+            description: string;
+            /**
+             * The activation parameters.
+             */
+            activation: {
+                /**
+                 * The KP cost.
+                 * @minLength 1
+                 */
+                cost: string;
+                /**
+                 * The duration.
+                 * @minLength 1
+                 */
+                duration: string;
+            };
+            errata?: Errata;
+        };
+    };
+};
+export declare const validateSchema: import("../validation/schema.js").TypeValidator<Talisman>;

package/lib/types/Talisman.js

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

package/lib/types/_Identifier.d.ts

@@ -163,6 +163,12 @@ declare enum RequirableSelectOptionTag {
     CloseCombatTechnique = "CloseCombatTechnique",
     RangedCombatTechnique = "RangedCombatTechnique"
 }
+declare enum CoreRuleDerivableContentTag {
+    MagicalTradition = "MagicalTradition",
+    FamiliarSpecialAbility = "FamiliarSpecialAbility",
+    MagicalSpecialAbility = "MagicalSpecialAbility",
+    BlessedTradition = "BlessedTradition"
+}
 declare type TaggedIdentifier<Tag> = {
     tag: Tag;
     /**
@@ -187,6 +193,7 @@ export declare type LiturgyIdentifier = TaggedIdentifier<LiturgyTag>;
 export declare type SpellworkIdentifier = TaggedIdentifier<SpellworkTag>;
 export declare type MagicalActionIdentifier = TaggedIdentifier<MagicalActionTag>;
 export declare type RequirableSelectOptionIdentifier = TaggedIdentifier<RequirableSelectOptionTag>;
+export declare type CoreRuleDerivableContentIdentifier = TaggedIdentifier<CoreRuleDerivableContentTag>;
 export declare type OneOrManyNumericIdentifiers = OneNumericIdentifier | ManyNumericIdentifiers;
 /**
  * @minimum 1

package/lib/types/_Identifier.js

@@ -178,4 +178,11 @@ var RequirableSelectOptionTag;
     RequirableSelectOptionTag["CloseCombatTechnique"] = "CloseCombatTechnique";
     RequirableSelectOptionTag["RangedCombatTechnique"] = "RangedCombatTechnique";
 })(RequirableSelectOptionTag || (RequirableSelectOptionTag = {}));
+var CoreRuleDerivableContentTag;
+(function (CoreRuleDerivableContentTag) {
+    CoreRuleDerivableContentTag["MagicalTradition"] = "MagicalTradition";
+    CoreRuleDerivableContentTag["FamiliarSpecialAbility"] = "FamiliarSpecialAbility";
+    CoreRuleDerivableContentTag["MagicalSpecialAbility"] = "MagicalSpecialAbility";
+    CoreRuleDerivableContentTag["BlessedTradition"] = "BlessedTradition";
+})(CoreRuleDerivableContentTag || (CoreRuleDerivableContentTag = {}));
 export {};

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

@@ -0,0 +1,52 @@
+/**
+ * @main EquipmentPackage
+ */
+/**
+ * @title Equipment Package
+ */
+export declare type EquipmentPackage = {
+    /**
+     * The equipment package's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All items in the package. You have to provide the item (template)
+     * identifier and you can optionally provide the number of how often an item
+     * 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;
+    }[];
+    /**
+     * 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;
+        };
+    };
+};
+export declare const validateSchema: import("../../validation/schema.js").TypeValidator<EquipmentPackage>;

package/lib/types/equipment/EquipmentPackage.js

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