optolith-database-schema 0.1.26 → 0.2.0

package/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 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.2.0](https://github.com/elyukai/optolith-database-schema/compare/v0.1.28...v0.2.0) (2022-03-29)
+
+
+### ⚠ BREAKING CHANGES
+
+* derived select options are not a list anymore
+
+* derived select options are not a list anymore ([fa64a60](https://github.com/elyukai/optolith-database-schema/commit/fa64a60670f0cdf5567a168f3a4eccd7ea71d367))
+
+### [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)
 
 

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/Race.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
 import { CommonnessRatedAdvantageDisadvantage } from "./_CommonnessRatedAdvantageDisadvantage.js";
+import { Dice, DieType } from "./_Dice.js";
 /**
  * A playable race with stats and skills.
  * @title Race
@@ -264,7 +265,7 @@ declare type StartingAgeConfigForExperienceLevel = {
      * The random value for the selected experience level. It is going to be
      * added to the base value.
      */
-    random: Die;
+    random: Dice;
 };
 /**
  * The race may have variants and associated configuration for each variant.
@@ -404,7 +405,7 @@ declare type Height = {
      * The dice used for random height.
      * @minItems 1
      */
-    random: Die[];
+    random: Dice[];
 };
 declare type RaceVariantTranslation = {
     /**
@@ -498,28 +499,5 @@ declare type RaceTranslation = {
     uncommon_disadvantages?: string;
     errata?: Errata;
 };
-/**
- * @title Die
- */
-declare type Die = {
-    /**
-     * Number of dice of the same type. Example: 2 in 2D6.
-     * @integer
-     * @minimum 1
-     */
-    number: number;
-    /**
-     * Number of sides on every die. Example: 6 in 2D6.
-     */
-    sides: DieType;
-};
-/**
- * Number of sides on every dice. Example: 6 in 2D6.
- */
-declare enum DieType {
-    D3 = 3,
-    D6 = 6,
-    D20 = 20
-}
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Race>;
 export {};

package/lib/types/Race.js

@@ -2,13 +2,4 @@
  * @main Race
  */
 import { validateSchemaCreator } from "../validation/schema.js";
-/**
- * Number of sides on every dice. Example: 6 in 2D6.
- */
-var DieType;
-(function (DieType) {
-    DieType[DieType["D3"] = 3] = "D3";
-    DieType[DieType["D6"] = 6] = "D6";
-    DieType[DieType["D20"] = 20] = "D20";
-})(DieType || (DieType = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/_Activatable.d.ts

@@ -6,7 +6,7 @@ import { DisplayOption } from "./prerequisites/DisplayOption.js";
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
 import { Duration } from "./_ActivatableSkill.js";
-import { ActivatableIdentifier, AdvancedSpecialAbilityRestrictedOptionIdentifier, CombatRelatedSpecialAbilityIdentifier, CombatTechniqueIdentifier, MagicalTraditionIdentifier, PatronIdentifier, VolumePointsOptionReferenceIdentifier } from "./_Identifier.js";
+import { ActivatableIdentifier, AdvancedSpecialAbilityRestrictedOptionIdentifier, CombatRelatedSpecialAbilityIdentifier, CombatTechniqueIdentifier, CombatTechniqueTag, MagicalTraditionIdentifier, PatronIdentifier, SkillIdentifier, SkillWithEnhancementsTag, VolumePointsOptionReferenceIdentifier } from "./_Identifier.js";
 import { GeneralPrerequisites } from "./_Prerequisite.js";
 /**
  * The activatable entry's identifier. An unique, increasing integer.
@@ -62,13 +62,13 @@ export declare type Maximum = number;
  */
 export declare type SelectOptions = {
     /**
-     * A list of categories with optional further configuration. All available
+     * An entry category with optional further configuration. All available
      * entries from the specified categories will be included as separate select
      * options. You can also specify a set of groups that should only be
      * included. Groups not mentioned will be excluded then.
      * @minItems 1
      */
-    derived?: CategoryOption[];
+    derived?: CategoryOption;
     /**
      * A list of explicit select options. If the identifier has a specific type,
      * its entry is the base of this select option, where values defined here
@@ -204,107 +204,146 @@ declare type CategoryOption = {
 } | {
     tag: "Skills";
     /**
-     * Only include entries of the specified groups.
+     * A list of skill categories.
      * @minItems 1
      */
-    groups?: {
+    categories: ({
+        tag: "Skills";
         /**
-         * The skill group's identifier.
-         * @integer
-         * @minimum 1
-         * @maximum 5
-         */
-        id: number;
-    }[];
-    /**
-     * Only include (`Intersection`) or exclude (`Difference`) specific skills.
-     */
-    specific?: {
-        operation: {
-            tag: "Intersection";
-        } | {
-            tag: "Difference";
-        };
-        /**
-         * The list of specific skills.
+         * Only include entries of the specified groups.
          * @minItems 1
-         * @uniqueItems
          */
-        list: {
+        groups?: {
             /**
-             * The skill's identifier.
+             * The skill group's identifier.
              * @integer
              * @minimum 1
-             * @maximum 59
+             * @maximum 5
              */
             id: number;
         }[];
-    };
-    /**
-     * Registers new applications, which get enabled once this entry is
-     * activated with its respective select option. It specifies an entry-unique
-     * identifier, the skill it belongs to is derived from the select option
-     * automatically. A translation can be left out if its name equals the name
-     * of the origin entry.
-     * @minItems 1
-     */
-    skill_applications?: {
         /**
-         * The application's identifier. An entry-unique, increasing integer.
-         * @integer
-         * @minimum 1
+         * Only include (`Intersection`) or exclude (`Difference`) specific
+         * skills.
          */
-        id: number;
+        specific?: {
+            operation: {
+                tag: "Intersection";
+            } | {
+                tag: "Difference";
+            };
+            /**
+             * The list of specific skills.
+             * @minItems 1
+             * @uniqueItems
+             */
+            list: {
+                /**
+                 * The skill's identifier.
+                 * @integer
+                 * @minimum 1
+                 * @maximum 59
+                 */
+                id: number;
+            }[];
+        };
         /**
-         * All translations for the entry, identified by IETF language tag (BCP47).
-         * @minProperties 1
+         * Registers new applications, which get enabled once this entry is
+         * activated with its respective select option. It specifies an
+         * entry-unique identifier, the skill it belongs to is derived from the
+         * select option automatically. A translation can be left out if its
+         * name equals the name of the origin entry.
+         * @minItems 1
          */
-        translations?: {
+        skill_applications?: {
             /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * The application's identifier. An entry-unique, increasing integer.
+             * @integer
+             * @minimum 1
              */
-            [localeId: string]: {
+            id: number;
+            /**
+             * All translations for the entry, identified by IETF language tag
+             * (BCP47).
+             * @minProperties 1
+             */
+            translations?: {
                 /**
-                 * The name of the application if different from the activatable entry's
-                 * name.
-                 * @minLength 1
+                 * @patternProperties ^[a-z]{2}-[A-Z]{2}$
                  */
-                name: string;
+                [localeId: string]: {
+                    /**
+                     * The name of the application if different from the activatable
+                     * entry's
+                     * name.
+                     * @minLength 1
+                     */
+                    name: string;
+                };
             };
-        };
-    }[];
-    /**
-     * Registers uses, which get enabled once this entry is activated with its
-     * respective select option. It specifies an entry-unique identifier, the
-     * skill it belongs to is derived from the select option automatically. A
-     * translation can be left out if its name equals the name of the origin
-     * entry.
-     * @minItems 1
-     */
-    skill_uses?: {
+        }[];
         /**
-         * The use's identifier. An entry-unique, increasing integer.
-         * @integer
-         * @minimum 1
+         * Registers uses, which get enabled once this entry is activated with
+         * its respective select option. It specifies an entry-unique
+         * identifier, the skill it belongs to is derived from the select option
+         * automatically. A translation can be left out if its name equals the
+         * name of the origin entry.
+         * @minItems 1
          */
-        id: number;
+        skill_uses?: {
+            /**
+             * The use's identifier. An entry-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 use if different from the activatable entry's
+                     * name.
+                     * @minLength 1
+                     */
+                    name: string;
+                };
+            };
+        }[];
+    } | {
+        tag: SkillWithEnhancementsTag;
         /**
-         * All translations for the entry, identified by IETF language tag (BCP47).
-         * @minProperties 1
+         * Only include (`Intersection`) or exclude (`Difference`) specific
+         * entries.
          */
-        translations?: {
+        specific?: {
+            operation: {
+                tag: "Intersection";
+            } | {
+                tag: "Difference";
+            };
             /**
-             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * The list of specific entries.
+             * @minItems 1
+             * @uniqueItems
              */
-            [localeId: string]: {
+            list: {
                 /**
-                 * The name of the use if different from the activatable entry's name.
-                 * @minLength 1
+                 * The entry's identifier.
+                 * @integer
+                 * @minimum 1
+                 * @maximum 59
                  */
-                name: string;
-            };
+                id: number;
+            }[];
         };
-    }[];
+    })[];
     /**
      * Generate prerequisites for each entry of the category.
      * @minItems 1
@@ -313,51 +352,51 @@ declare type CategoryOption = {
     /**
      * Generate AP values for each entry.
      */
-    ap_value?: OptionSkillDeriveAdventurePointsValue;
-} | {
-    tag: NonSkillSkillCategory;
-    /**
-     * Only include (`Intersection`) or exclude (`Difference`) specific entries.
-     */
-    specific?: {
-        operation: {
-            tag: "Intersection";
-        } | {
-            tag: "Difference";
-        };
+    ap_value?: OptionSkillDeriveAdventurePointsValue<SkillIdentifier> | {
+        tag: "CombatTechniques";
         /**
-         * The list of specific entries.
+         * A list of combat technique categories.
          * @minItems 1
-         * @uniqueItems
          */
-        list: {
+        categories: {
+            tag: CombatTechniqueTag;
             /**
-             * The entry's identifier.
-             * @integer
-             * @minimum 1
-             * @maximum 59
+             * Only include (`Intersection`) or exclude (`Difference`) specific
+             * entries.
              */
-            id: number;
+            specific?: {
+                operation: {
+                    tag: "Intersection";
+                } | {
+                    tag: "Difference";
+                };
+                /**
+                 * The list of specific entries.
+                 * @minItems 1
+                 * @uniqueItems
+                 */
+                list: {
+                    /**
+                     * The entry's identifier.
+                     * @integer
+                     * @minimum 1
+                     * @maximum 59
+                     */
+                    id: number;
+                }[];
+            };
         }[];
+        /**
+         * Generate prerequisites for each entry of the category.
+         * @minItems 1
+         */
+        prerequisites?: (OptionSkillSelfPrerequisite | OptionOptionPrerequisite)[];
+        /**
+         * Generate AP values for each entry.
+         */
+        ap_value?: OptionSkillDeriveAdventurePointsValue<CombatTechniqueIdentifier>;
     };
-    /**
-     * Generate prerequisites for each entry of the category.
-     * @minItems 1
-     */
-    prerequisites?: (OptionSkillSelfPrerequisite | OptionOptionPrerequisite)[];
-    /**
-     * Generate AP values for each entry.
-     */
-    ap_value?: OptionSkillDeriveAdventurePointsValue;
 };
-declare enum NonSkillSkillCategory {
-    CloseCombatTechniques = "CloseCombatTechniques",
-    RangedCombatTechniques = "RangedCombatTechniques",
-    LiturgicalChants = "LiturgicalChants",
-    Ceremonies = "Ceremonies",
-    Spells = "Spells",
-    Rituals = "Rituals"
-}
 declare type OptionSkillSelfPrerequisite = {
     tag: "Self";
     /**
@@ -390,7 +429,7 @@ declare type OptionOptionPrerequisite = {
 /**
  * Generate AP values for each entry.
  */
-declare type OptionSkillDeriveAdventurePointsValue = {
+declare type OptionSkillDeriveAdventurePointsValue<Identifier> = {
     tag: "DerivedFromImprovementCost";
     /**
      * This number is multiplied with the improvement cost of the entry
@@ -410,7 +449,7 @@ declare type OptionSkillDeriveAdventurePointsValue = {
          * @integer
          * @minimum 1
          */
-        id: number;
+        id: Identifier;
         /**
          * The AP value for the specified entry.
          * @integer

package/lib/types/_Activatable.js

@@ -2,15 +2,6 @@
  * General type specifications used by multiple activatable entries.
  * @title Activatable
  */
-var NonSkillSkillCategory;
-(function (NonSkillSkillCategory) {
-    NonSkillSkillCategory["CloseCombatTechniques"] = "CloseCombatTechniques";
-    NonSkillSkillCategory["RangedCombatTechniques"] = "RangedCombatTechniques";
-    NonSkillSkillCategory["LiturgicalChants"] = "LiturgicalChants";
-    NonSkillSkillCategory["Ceremonies"] = "Ceremonies";
-    NonSkillSkillCategory["Spells"] = "Spells";
-    NonSkillSkillCategory["Rituals"] = "Rituals";
-})(NonSkillSkillCategory || (NonSkillSkillCategory = {}));
 export {};
 // "Input": {
 //   "description": "A string that is used as a placeholder text for an input field.",

package/lib/types/_Dice.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @title Dice
+ */
+export declare type Dice = {
+    /**
+     * Number of dice of the same type. Example: 2 in 2D6.
+     * @integer
+     * @minimum 1
+     */
+    number: number;
+    /**
+     * Number of sides on every die. Example: 6 in 2D6.
+     */
+    sides: DieType;
+};
+/**
+ * Number of sides on every dice. Example: 6 in 2D6.
+ */
+export declare enum DieType {
+    D3 = 3,
+    D6 = 6,
+    D20 = 20
+}

package/lib/types/_Dice.js

@@ -0,0 +1,9 @@
+/**
+ * Number of sides on every dice. Example: 6 in 2D6.
+ */
+export var DieType;
+(function (DieType) {
+    DieType[DieType["D3"] = 3] = "D3";
+    DieType[DieType["D6"] = 6] = "D6";
+    DieType[DieType["D20"] = 20] = "D20";
+})(DieType || (DieType = {}));

package/lib/types/_Identifier.d.ts

@@ -108,15 +108,23 @@ declare enum RatedTag {
     LiturgicalChant = "LiturgicalChant",
     Ceremony = "Ceremony"
 }
+declare enum SkillTag {
+    Skill = "Skill",
+    Spell = "Spell",
+    Ritual = "Ritual",
+    LiturgicalChant = "LiturgicalChant",
+    Ceremony = "Ceremony"
+}
 declare enum AdvancedSpecialAbilityRestrictedOptionTag {
     General = "General",
+    Skill = "Skill",
     Element = "Element"
 }
 declare enum VolumePointsOptionReferenceTag {
     General = "General",
     AnimalShapeSize = "AnimalShapeSize"
 }
-declare enum CombatTechniqueTag {
+export declare enum CombatTechniqueTag {
     CloseCombatTechnique = "CloseCombatTechnique",
     RangedCombatTechnique = "RangedCombatTechnique"
 }
@@ -130,7 +138,7 @@ declare enum ExtensionRuleTag {
     FocusRule = "FocusRule",
     OptionalRule = "OptionalRule"
 }
-declare enum SkillWithEnhancementsTag {
+export declare enum SkillWithEnhancementsTag {
     Spell = "Spell",
     Ritual = "Ritual",
     LiturgicalChant = "LiturgicalChant",
@@ -182,6 +190,7 @@ export declare type ActivatableIdentifier = TaggedIdentifier<ActivatableTag>;
 export declare type SpecialAbilityIdentifier = TaggedIdentifier<SpecialAbilityTag>;
 export declare type CombatRelatedSpecialAbilityIdentifier = TaggedIdentifier<CombatRelatedSpecialAbilityTag>;
 export declare type RatedIdentifier = TaggedIdentifier<RatedTag>;
+export declare type SkillIdentifier = TaggedIdentifier<SkillTag>;
 export declare type AdvancedSpecialAbilityRestrictedOptionIdentifier = TaggedIdentifier<AdvancedSpecialAbilityRestrictedOptionTag>;
 export declare type VolumePointsOptionReferenceIdentifier = TaggedIdentifier<VolumePointsOptionReferenceTag>;
 export declare type CombatTechniqueIdentifier = TaggedIdentifier<CombatTechniqueTag>;

package/lib/types/_Identifier.js

@@ -112,9 +112,18 @@ var RatedTag;
     RatedTag["LiturgicalChant"] = "LiturgicalChant";
     RatedTag["Ceremony"] = "Ceremony";
 })(RatedTag || (RatedTag = {}));
+var SkillTag;
+(function (SkillTag) {
+    SkillTag["Skill"] = "Skill";
+    SkillTag["Spell"] = "Spell";
+    SkillTag["Ritual"] = "Ritual";
+    SkillTag["LiturgicalChant"] = "LiturgicalChant";
+    SkillTag["Ceremony"] = "Ceremony";
+})(SkillTag || (SkillTag = {}));
 var AdvancedSpecialAbilityRestrictedOptionTag;
 (function (AdvancedSpecialAbilityRestrictedOptionTag) {
     AdvancedSpecialAbilityRestrictedOptionTag["General"] = "General";
+    AdvancedSpecialAbilityRestrictedOptionTag["Skill"] = "Skill";
     AdvancedSpecialAbilityRestrictedOptionTag["Element"] = "Element";
 })(AdvancedSpecialAbilityRestrictedOptionTag || (AdvancedSpecialAbilityRestrictedOptionTag = {}));
 var VolumePointsOptionReferenceTag;
@@ -122,7 +131,7 @@ var VolumePointsOptionReferenceTag;
     VolumePointsOptionReferenceTag["General"] = "General";
     VolumePointsOptionReferenceTag["AnimalShapeSize"] = "AnimalShapeSize";
 })(VolumePointsOptionReferenceTag || (VolumePointsOptionReferenceTag = {}));
-var CombatTechniqueTag;
+export var CombatTechniqueTag;
 (function (CombatTechniqueTag) {
     CombatTechniqueTag["CloseCombatTechnique"] = "CloseCombatTechnique";
     CombatTechniqueTag["RangedCombatTechnique"] = "RangedCombatTechnique";
@@ -140,7 +149,7 @@ var ExtensionRuleTag;
     ExtensionRuleTag["FocusRule"] = "FocusRule";
     ExtensionRuleTag["OptionalRule"] = "OptionalRule";
 })(ExtensionRuleTag || (ExtensionRuleTag = {}));
-var SkillWithEnhancementsTag;
+export var SkillWithEnhancementsTag;
 (function (SkillWithEnhancementsTag) {
     SkillWithEnhancementsTag["Spell"] = "Spell";
     SkillWithEnhancementsTag["Ritual"] = "Ritual";
@@ -185,4 +194,3 @@ var CoreRuleDerivableContentTag;
     CoreRuleDerivableContentTag["MagicalSpecialAbility"] = "MagicalSpecialAbility";
     CoreRuleDerivableContentTag["BlessedTradition"] = "BlessedTradition";
 })(CoreRuleDerivableContentTag || (CoreRuleDerivableContentTag = {}));
-export {};