optolith-database-schema 0.1.25 → 0.1.28

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.28](https://github.com/elyukai/optolith-database-schema/compare/v0.1.27...v0.1.28) (2022-03-25)
+
+
+### Features
+
+* allow skills in advanced special ability restrictions ([237dbbd](https://github.com/elyukai/optolith-database-schema/commit/237dbbdeddcc0df07387196ae2537a19c1deab16))
+* items status quo ([c4b349b](https://github.com/elyukai/optolith-database-schema/commit/c4b349bf10fca92286c0510cab8ccb67563f0532))
+
+### [0.1.27](https://github.com/elyukai/optolith-database-schema/compare/v0.1.26...v0.1.27) (2022-03-24)
+
+
+### Bug Fixes
+
+* maximum call stack size exceeded with ui schema ([a752342](https://github.com/elyukai/optolith-database-schema/commit/a752342708b2a3e4b98e57a0adcbfd9b449d02fe))
+
+### [0.1.26](https://github.com/elyukai/optolith-database-schema/compare/v0.1.25...v0.1.26) (2022-03-24)
+
+
+### Features
+
+* animal diseases ([b7d2639](https://github.com/elyukai/optolith-database-schema/commit/b7d263942c14c76b6a3bfda780ecadf6cb7a60df))
+* armor types ([c5b9a22](https://github.com/elyukai/optolith-database-schema/commit/c5b9a22e5c277a28a8bc0c8cbe3b0cc41235087d))
+* diseases ([5e7c8a6](https://github.com/elyukai/optolith-database-schema/commit/5e7c8a6f83ce0b3f7c3854e759b8f042ed7451c8))
+* item groups ([b2678ac](https://github.com/elyukai/optolith-database-schema/commit/b2678aca250d4666f7a894ddfc0fc9c3f6a22bcf))
+* poisons ([fb9898f](https://github.com/elyukai/optolith-database-schema/commit/fb9898fbce8fcaaed0f83f8afe8fafeab8294a28))
+* reaches ([9ed3937](https://github.com/elyukai/optolith-database-schema/commit/9ed39370410a3af29c585a3321c59e794dad70ae))
+* ui status quo ([5cb5058](https://github.com/elyukai/optolith-database-schema/commit/5cb50581de6bb3c9a4ee7a89ae52a1dea957c8d8))
+
 ### [0.1.25](https://github.com/elyukai/optolith-database-schema/compare/v0.1.24...v0.1.25) (2022-03-23)
 
 

package/lib/config.d.ts

@@ -1,4 +1,6 @@
 import { Advantage } from "./types/Advantage.js";
+import { AnimalDisease } from "./types/AnimalDisease.js";
+import { AnimalType } from "./types/AnimalType.js";
 import { ArcaneBardTradition } from "./types/ArcaneBardTradition.js";
 import { ArcaneDancerTradition } from "./types/ArcaneDancerTradition.js";
 import { Aspect } from "./types/Aspect.js";
@@ -13,12 +15,15 @@ import { Continent } from "./types/Continent.js";
 import { Culture } from "./types/Culture.js";
 import { DerivedCharacteristic } from "./types/DerivedCharacteristic.js";
 import { Disadvantage } from "./types/Disadvantage.js";
+import { Disease } from "./types/Disease.js";
 import { Element } from "./types/Element.js";
+import { ArmorType } from "./types/equipment/ArmorType.js";
 import { EquipmentPackage } from "./types/equipment/EquipmentPackage.js";
+import { ItemGroup } from "./types/equipment/ItemGroup.js";
+import { Reach } from "./types/equipment/Reach.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";
@@ -42,6 +47,7 @@ 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 { Poison } from "./types/Poison.js";
 import { Profession } from "./types/Profession.js";
 import { Property } from "./types/Property.js";
 import { Race } from "./types/Race.js";
@@ -116,6 +122,7 @@ import { ToyEnchantment } from "./types/traditionArtifacts/ToyEnchantment.js";
 import { Trinkhornzauber } from "./types/traditionArtifacts/Trinkhornzauber.js";
 import { WandEnchantment } from "./types/traditionArtifacts/WandEnchantment.js";
 import { WeaponEnchantment } from "./types/traditionArtifacts/WeaponEnchantment.js";
+import { UI } from "./types/UI.js";
 import { TypeValidator } from "./validation/schema.js";
 export declare type TypeMap = {
     advancedCombatSpecialAbilities: AdvancedCombatSpecialAbility;
@@ -124,14 +131,17 @@ export declare type TypeMap = {
     advancedSkillSpecialAbilities: AdvancedSkillSpecialAbility;
     advantages: Advantage;
     ancestorGlyphs: AncestorGlyph;
+    animalDiseases: AnimalDisease;
     animalShapePaths: AnimalShapePath;
     animalShapes: AnimalShape;
     animalShapeSizes: AnimalShapeSize;
+    animalTypes: AnimalType;
     animistPowers: AnimistPower;
     animistPowerTribes: Tribe;
     arcaneBardTraditions: ArcaneBardTradition;
     arcaneDancerTraditions: ArcaneDancerTradition;
     arcaneOrbEnchantments: ArcaneOrbEnchantment;
+    armorTypes: ArmorType;
     aspects: Aspect;
     attireEnchantments: AttireEnchantment;
     attributes: Attribute;
@@ -157,6 +167,7 @@ export declare type TypeMap = {
     daggerRituals: DaggerRitual;
     derivedCharacteristics: DerivedCharacteristic;
     disadvantages: Disadvantage;
+    diseases: Disease;
     dominationRituals: DominationRitual;
     elements: Element;
     elvenMagicalSongs: ElvenMagicalSong;
@@ -164,7 +175,6 @@ export declare type TypeMap = {
     experienceLevels: ExperienceLevel;
     eyeColors: EyeColor;
     familiarSpecialAbilities: FamiliarSpecialAbility;
-    familiarsTrickAnimalTypes: AnimalType;
     familiarsTricks: FamiliarsTrick;
     fatePointSexSpecialAbilities: FatePointSexSpecialAbility;
     fatePointSpecialAbilities: FatePointSpecialAbility;
@@ -175,6 +185,7 @@ export declare type TypeMap = {
     geodeRituals: GeodeRitual;
     hairColors: HairColor;
     instrumentEnchantments: InstrumentEnchantment;
+    itemGroups: ItemGroup;
     jesterTricks: JesterTrick;
     karmaSpecialAbilities: KarmaSpecialAbility;
     kirchenpraegungen: Kirchenpraegung;
@@ -201,12 +212,14 @@ export declare type TypeMap = {
     patronCategories: PatronCategory;
     patrons: Patron;
     personalityTraits: PersonalityTrait;
+    poisons: Poison;
     professions: Profession;
     properties: Property;
     protectiveWardingCircleSpecialAbilities: ProtectiveWardingCircleSpecialAbility;
     publications: Publication;
     races: Race;
     rangedCombatTechniques: RangedCombatTechnique;
+    reaches: Reach;
     regions: Region;
     ringEnchantments: RingEnchantment;
     rituals: Ritual;
@@ -231,6 +244,7 @@ export declare type TypeMap = {
     toyEnchantments: ToyEnchantment;
     tradeSecrets: TradeSecret;
     trinkhornzauber: Trinkhornzauber;
+    ui: UI;
     vampiricGifts: VampiricGift;
     visions: Vision;
     wandEnchantments: WandEnchantment;

package/lib/config.js

@@ -1,4 +1,6 @@
 import { validateSchema as validateAdvantageSchema } from "./types/Advantage.js";
+import { validateSchema as validateAnimalDiseaseSchema } from "./types/AnimalDisease.js";
+import { validateSchema as validateAnimalTypeSchema } from "./types/AnimalType.js";
 import { validateSchema as validateArcaneBardTraditionSchema } from "./types/ArcaneBardTradition.js";
 import { validateSchema as validateArcaneDancerTraditionSchema } from "./types/ArcaneDancerTradition.js";
 import { validateSchema as validateAspectSchema } from "./types/Aspect.js";
@@ -13,12 +15,15 @@ import { validateSchema as validateContinentSchema } from "./types/Continent.js"
 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 validateDiseaseSchema } from "./types/Disease.js";
 import { validateSchema as validateElementSchema } from "./types/Element.js";
+import { validateSchema as validateArmorTypeSchema } from "./types/equipment/ArmorType.js";
 import { validateSchema as validateEquipmentPackageSchema } from "./types/equipment/EquipmentPackage.js";
+import { validateSchema as validateItemGroupSchema } from "./types/equipment/ItemGroup.js";
+import { validateSchema as validateReachSchema } from "./types/equipment/Reach.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";
@@ -42,6 +47,7 @@ import { validateSchema as validatePactCategorySchema } from "./types/PactCatego
 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 validatePoisonSchema } from "./types/Poison.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";
@@ -116,6 +122,7 @@ import { validateSchema as validateToyEnchantmentSchema } from "./types/traditio
 import { validateSchema as validateTrinkhornzauberSchema } from "./types/traditionArtifacts/Trinkhornzauber.js";
 import { validateSchema as validateWandEnchantmentSchema } from "./types/traditionArtifacts/WandEnchantment.js";
 import { validateSchema as validateWeaponEnchantmentSchema } from "./types/traditionArtifacts/WeaponEnchantment.js";
+import { validateSchema as validateUISchema } from "./types/UI.js";
 export const typeValidatorMap = {
     advancedCombatSpecialAbilities: validateAdvancedCombatSpecialAbilitySchema,
     advancedKarmaSpecialAbilities: validateAdvancedKarmaSpecialAbilitySchema,
@@ -123,14 +130,17 @@ export const typeValidatorMap = {
     advancedSkillSpecialAbilities: validateAdvancedSkillSpecialAbilitySchema,
     advantages: validateAdvantageSchema,
     ancestorGlyphs: validateAncestorGlyphSchema,
+    animalDiseases: validateAnimalDiseaseSchema,
     animalShapePaths: validateAnimalShapePathSchema,
     animalShapes: validateAnimalShapeSchema,
     animalShapeSizes: validateAnimalShapeSizeSchema,
+    animalTypes: validateAnimalTypeSchema,
     animistPowers: validateAnimistPowerSchema,
     animistPowerTribes: validateTribeSchema,
     arcaneBardTraditions: validateArcaneBardTraditionSchema,
     arcaneDancerTraditions: validateArcaneDancerTraditionSchema,
     arcaneOrbEnchantments: validateArcaneOrbEnchantmentSchema,
+    armorTypes: validateArmorTypeSchema,
     aspects: validateAspectSchema,
     attireEnchantments: validateAttireEnchantmentSchema,
     attributes: validateAttributeSchema,
@@ -156,6 +166,7 @@ export const typeValidatorMap = {
     daggerRituals: validateDaggerRitualSchema,
     derivedCharacteristics: validateDerivedCharacteristicSchema,
     disadvantages: validateDisadvantageSchema,
+    diseases: validateDiseaseSchema,
     dominationRituals: validateDominationRitualSchema,
     elements: validateElementSchema,
     elvenMagicalSongs: validateElvenMagicalSongSchema,
@@ -163,7 +174,6 @@ export const typeValidatorMap = {
     experienceLevels: validateExperienceLevelSchema,
     eyeColors: validateEyeColorSchema,
     familiarSpecialAbilities: validateFamiliarSpecialAbilitySchema,
-    familiarsTrickAnimalTypes: validateAnimalTypeSchema,
     familiarsTricks: validateFamiliarsTrickSchema,
     fatePointSexSpecialAbilities: validateFatePointSexSpecialAbilitySchema,
     fatePointSpecialAbilities: validateFatePointSpecialAbilitySchema,
@@ -174,6 +184,7 @@ export const typeValidatorMap = {
     geodeRituals: validateGeodeRitualSchema,
     hairColors: validateHairColorSchema,
     instrumentEnchantments: validateInstrumentEnchantmentSchema,
+    itemGroups: validateItemGroupSchema,
     jesterTricks: validateJesterTrickSchema,
     karmaSpecialAbilities: validateKarmaSpecialAbilitySchema,
     kirchenpraegungen: validateKirchenpraegungSchema,
@@ -200,12 +211,14 @@ export const typeValidatorMap = {
     patronCategories: validatePatronCategorySchema,
     patrons: validatePatronSchema,
     personalityTraits: validatePersonalityTraitSchema,
+    poisons: validatePoisonSchema,
     professions: validateProfessionSchema,
     properties: validatePropertySchema,
     protectiveWardingCircleSpecialAbilities: validateProtectiveWardingCircleSpecialAbilitySchema,
     publications: validatePublicationSchema,
     races: validateRaceSchema,
     rangedCombatTechniques: validateRangedCombatTechniqueSchema,
+    reaches: validateReachSchema,
     regions: validateRegionSchema,
     ringEnchantments: validateRingEnchantmentSchema,
     rituals: validateRitualSchema,
@@ -230,6 +243,7 @@ export const typeValidatorMap = {
     toyEnchantments: validateToyEnchantmentSchema,
     tradeSecrets: validateTradeSecretSchema,
     trinkhornzauber: validateTrinkhornzauberSchema,
+    ui: validateUISchema,
     vampiricGifts: validateVampiricGiftSchema,
     visions: validateVisionSchema,
     wandEnchantments: validateWandEnchantmentSchema,

package/lib/main.js

@@ -22,12 +22,11 @@ const readdirRecursive = async (dirPath) => {
     return flattenedRecursivePaths.flat();
 };
 const registerAllJsonSchemaDocuments = async (validator) => {
-    const allJsonSchemaFilePaths = await readdirRecursive(jsonSchemaDir);
     const readFileAsUtf8 = (path) => readFile(path, "utf-8");
     const readFilesAsUtf8 = (paths) => Promise.all(paths.map(readFileAsUtf8));
     const parseJson = (json) => JSON.parse(json);
     const registerSchemaInValidator = (jsonSchema) => { validator.addSchema(jsonSchema); };
-    (await readFilesAsUtf8(allJsonSchemaFilePaths))
+    (await readFilesAsUtf8(await readdirRecursive(jsonSchemaDir)))
         .map(parseJson)
         .forEach(registerSchemaInValidator);
 };
@@ -48,14 +47,11 @@ const validateAllFromType = async (validator, typeName, path) => {
     const isFile = (await lstat(path)).isFile();
     const typeValidator = typeValidatorMap[typeName];
     if (isFile) {
-        return [typeName, { [path]: typeValidator(validator, await readFile(path, "utf-8"), path) }];
+        return { [path]: typeValidator(validator, await readFile(path, "utf-8"), path) };
     }
     else {
         const dataFiles = await readDataFileAssocsFromDirectory(path);
-        return [
-            typeName,
-            Object.fromEntries(dataFiles.map(([filePath, fileContent]) => [filePath, typeValidator(validator, fileContent, filePath)]))
-        ];
+        return Object.fromEntries(dataFiles.map(([filePath, fileContent]) => [filePath, typeValidator(validator, fileContent, filePath)]));
     }
 };
 const rawResultMapToResult = (rawResultMap) => Object.entries(rawResultMap).reduce((result, [typeName, typeResults]) => Object.entries(typeResults).reduce((outerResult, [filePath, fileResult]) => {
@@ -93,11 +89,14 @@ const rawResultMapToResult = (rawResultMap) => Object.entries(rawResultMap).redu
     value: {}
 }));
 export const validate = async (entityDirPaths, checkIntegrity) => {
-    const validator = new Ajv();
+    const validator = new Ajv({ allErrors: true });
     addFormats(validator);
     await registerAllJsonSchemaDocuments(validator);
     const rawResultMap = Object.fromEntries((await Promise.all(Object.entries(entityDirPaths)
-        .map(async ([typeName, path]) => validateAllFromType(validator, typeName, path)))));
+        .map(async ([typeName, path]) => [
+        typeName,
+        await validateAllFromType(validator, typeName, path)
+    ]))));
     return rawResultMapToResult(rawResultMap);
 };
 export const printErrors = (errorsByFile) => Object.entries(errorsByFile)

package/lib/types/AnimalDisease.d.ts

@@ -0,0 +1,252 @@
+/**
+ * @main AnimalDisease
+ */
+import { Errata } from "./source/_Erratum.js";
+import { PublicationRefs } from "./source/_PublicationRef.js";
+/**
+ * @title Animal Disease
+ */
+export declare type AnimalDisease = {
+    /**
+     * The animal disease's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The animal disease's level.
+     * @integer
+     * @minimum 1
+     */
+    level: number;
+    /**
+     * Depending on the disease, apply Spirit or Toughness as a penalty to the
+     * disease roll. It may also happen that the lower of both is applied as a
+     * penalty.
+     */
+    resistance: {
+        tag: "Spirit";
+    } | {
+        tag: "Toughness";
+    } | {
+        tag: "LowerOfSpiritAndToughness";
+    };
+    /**
+     * What causes the disease? The GM rolls 1D20 to see if a character gets
+     * infected. If the infection check succeeds, the GM makes a disease check to
+     * determine the severity of the infection.
+     * @minItems 1
+     */
+    cause: {
+        /**
+         * The chance to get infected by this cause, in percent.
+         * @integer
+         * @minimum 5
+         * @multipleOf 5
+         * @maximum 100
+         */
+        chance?: 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 cause.
+                 * @minLength 1
+                 */
+                name: string;
+                /**
+                 * The chance to get infected by this cause. If present for this
+                 * language, this overrides the universal `chance` field; they cannot be
+                 * used at the same time.
+                 * @minLength 1
+                 */
+                chance?: string;
+                /**
+                 * An additional note about this cause.
+                 * @minLength 1
+                 */
+                note?: string;
+            };
+        };
+    }[];
+    /**
+     * The animal types this disease applies to.
+     */
+    animal_types: {
+        tag: "All";
+    } | {
+        tag: "Specific";
+        /**
+         * The list of specific animal types this disease applies to.
+         * @minItems 1
+         */
+        list: {
+            /**
+             * The animal type's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        }[];
+    };
+    communicability_to_intelligent_creatures: {
+        tag: "NonCommunicable";
+    } | {
+        tag: "Communicable";
+        /**
+         * What causes the communication? The GM rolls 1D20 to see if a character
+         * gets infected. If the infection check succeeds, the GM makes a disease
+         * check to determine the severity of the infection.
+         * @minItems 1
+         */
+        cause: {
+            /**
+             * The chance to get infected by this cause, in percent.
+             * @integer
+             * @minimum 5
+             * @multipleOf 5
+             * @maximum 100
+             */
+            chance?: 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 cause.
+                     * @minLength 1
+                     */
+                    name: string;
+                    /**
+                     * The chance to get infected by this cause. If present for this
+                     * language, this overrides the universal `chance` field; they
+                     * cannot be used at the same time.
+                     * @minLength 1
+                     */
+                    chance?: string;
+                    /**
+                     * An additional note about this communication cause.
+                     * @minLength 1
+                     */
+                    note?: string;
+                };
+            };
+        }[];
+    };
+    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 animal disease.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * A list of alternative names.
+             * @minItems 1
+             */
+            alternative_names?: {
+                /**
+                 * An alternative name of the animal disease.
+                 * @minLength 1
+                 */
+                name: string;
+                /**
+                 * The region where this alternative name is used.
+                 * @minLength 1
+                 */
+                region?: string;
+            }[];
+            /**
+             * The disease’s progress, in detail.
+             * @markdown
+             * @minLength 1
+             */
+            progress: string;
+            /**
+             * After infection, how much time passes before symptoms appear?
+             * @minLength 1
+             */
+            incubation_time: string;
+            /**
+             * The damage caused by the disease. If the disease check fails, apply the
+             * lessened effects.
+             */
+            damage: {
+                /**
+                 * The disease’s default damage. In the source, it's the text before the
+                 * slash.
+                 * @markdown
+                 * @minLength 1
+                 */
+                default: string;
+                /**
+                 * The disease’s lessened damage. In the source, it's the text after the
+                 * slash.
+                 * @markdown
+                 * @minLength 1
+                 */
+                lessened?: string;
+            };
+            /**
+             * The duration of the disease. If the disease check fails, use the
+             * lessened duration.
+             */
+            duration: {
+                /**
+                 * The default duration of the disease. In the source, it's the text
+                 * before the slash.
+                 * @markdown
+                 * @minLength 1
+                 */
+                default: string;
+                /**
+                 * The lessened duration of the disease. In the source, it's the text
+                 * after the slash.
+                 * @markdown
+                 * @minLength 1
+                 */
+                lessened?: string;
+            };
+            /**
+             * Special information about the disease.
+             * @markdown
+             * @minLength 1
+             */
+            special?: string;
+            /**
+             * Methods known to lessen the disease’s progress or relieve symptoms.
+             * @markdown
+             * @minLength 1
+             */
+            treatment: string;
+            /**
+             * Known remedies for the disease.
+             * @markdown
+             * @minLength 1
+             */
+            cure: string;
+            errata?: Errata;
+        };
+    };
+};
+export declare const validateSchema: import("../validation/schema.js").TypeValidator<AnimalDisease>;

package/lib/types/AnimalDisease.js

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