optolith-database-schema 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.4.0](https://github.com/elyukai/optolith-database-schema/compare/v0.3.0...v0.4.0) (2022-08-01)
+
+
+### ⚠ BREAKING CHANGES
+
+* streamline enums with and without associated values
+
+### Features
+
+* adjust equipment item schemes based on example files ([a7344f2](https://github.com/elyukai/optolith-database-schema/commit/a7344f2faa8a414ca62586b884e7eb5892645fef))
+
+
+* streamline enums with and without associated values ([a4685e3](https://github.com/elyukai/optolith-database-schema/commit/a4685e34999ada051117834fc17d19b41f5f3304))
+
 ## [0.3.0](https://github.com/elyukai/optolith-database-schema/compare/v0.2.4...v0.3.0) (2022-07-23)
 
 

package/lib/config.d.ts

@@ -30,8 +30,8 @@ import * as Clothes from "./types/equipment/item/Clothes.js";
 import * as Container from "./types/equipment/item/Container.js";
 import * as EquipmentOfBlessedOnes from "./types/equipment/item/EquipmentOfBlessedOnes.js";
 import * as GemOrPreciousStone from "./types/equipment/item/GemOrPreciousStone.js";
-import * as HealingHerb from "./types/equipment/item/HealingHerb.js";
-import * as Illumination from "./types/equipment/item/Illumination.js";
+import * as IlluminationLightSource from "./types/equipment/item/IlluminationLightSource.js";
+import * as IlluminationRefillsOrSupplies from "./types/equipment/item/IlluminationRefillsOrSupplies.js";
 import * as Jewelry from "./types/equipment/item/Jewelry.js";
 import * as Liebesspielzeug from "./types/equipment/item/Liebesspielzeug.js";
 import * as LuxuryGood from "./types/equipment/item/LuxuryGood.js";
@@ -222,8 +222,8 @@ export declare type TypeMap = {
     generalSpecialAbilities: GeneralSpecialAbility.GeneralSpecialAbility;
     geodeRituals: GeodeRitual.GeodeRitual;
     hairColors: HairColor.HairColor;
-    healingHerbs: HealingHerb.HealingHerb;
-    illumination: Illumination.Illumination;
+    illuminationLightSources: IlluminationLightSource.IlluminationLightSource;
+    illuminationRefillsAndSupplies: IlluminationRefillsOrSupplies.IlluminationRefillsOrSupplies;
     instrumentEnchantments: InstrumentEnchantment.InstrumentEnchantment;
     jesterTricks: JesterTrick.JesterTrick;
     jewelry: Jewelry.Jewelry;

package/lib/config.js

@@ -30,8 +30,8 @@ import * as Clothes from "./types/equipment/item/Clothes.js";
 import * as Container from "./types/equipment/item/Container.js";
 import * as EquipmentOfBlessedOnes from "./types/equipment/item/EquipmentOfBlessedOnes.js";
 import * as GemOrPreciousStone from "./types/equipment/item/GemOrPreciousStone.js";
-import * as HealingHerb from "./types/equipment/item/HealingHerb.js";
-import * as Illumination from "./types/equipment/item/Illumination.js";
+import * as IlluminationLightSource from "./types/equipment/item/IlluminationLightSource.js";
+import * as IlluminationRefillsOrSupplies from "./types/equipment/item/IlluminationRefillsOrSupplies.js";
 import * as Jewelry from "./types/equipment/item/Jewelry.js";
 import * as Liebesspielzeug from "./types/equipment/item/Liebesspielzeug.js";
 import * as LuxuryGood from "./types/equipment/item/LuxuryGood.js";
@@ -221,8 +221,8 @@ export const typeValidatorMap = {
     generalSpecialAbilities: GeneralSpecialAbility.validateSchema,
     geodeRituals: GeodeRitual.validateSchema,
     hairColors: HairColor.validateSchema,
-    healingHerbs: HealingHerb.validateSchema,
-    illumination: Illumination.validateSchema,
+    illuminationLightSources: IlluminationLightSource.validateSchema,
+    illuminationRefillsAndSupplies: IlluminationRefillsOrSupplies.validateSchema,
     instrumentEnchantments: InstrumentEnchantment.validateSchema,
     jesterTricks: JesterTrick.validateSchema,
     jewelry: Jewelry.validateSchema,

package/lib/types/Blessing.d.ts

@@ -66,14 +66,17 @@ export declare type BlessingPerformanceParameters = {
 };
 export declare type BlessingRange = {
     tag: "Self";
+    self: {};
 } | {
     tag: "Touch";
+    touch: {};
 } | {
     tag: "Fixed";
     fixed: FixedRange;
 };
 export declare type BlessingDuration = {
     tag: "Immediate";
+    immediate: {};
 } | {
     tag: "Fixed";
     fixed: FixedBlessingDuration;

package/lib/types/Cantrip.d.ts

@@ -131,14 +131,17 @@ export declare type CantripPerformanceParameters = {
 };
 export declare type CantripRange = {
     tag: "Self";
+    self: {};
 } | {
     tag: "Touch";
+    touch: {};
 } | {
     tag: "Fixed";
     fixed: FixedRange;
 };
 export declare type CantripDuration = {
     tag: "Immediate";
+    immediate: {};
 } | {
     tag: "Fixed";
     fixed: FixedCantripDuration;

package/lib/types/Culture.d.ts

@@ -101,11 +101,10 @@ export declare type AreaKnowledge = {
  * Some professions or profession variants are simply more common (Mostly), but
  * sometimes only specific elements are used (Only).
  */
-export declare type Weight = {
-    tag: "Mostly";
-} | {
-    tag: "Only";
-};
+export declare enum Weight {
+    Mostly = "Mostly",
+    Only = "Only"
+}
 /**
  * Some professions or profession variants are more common than others. There
  * may be cultures where some professions or profession variants are not
@@ -130,11 +129,10 @@ export declare type Weighted<ProfessionOrVariant> = {
  * that intersect with the constraints (include) or only the professions
  * are kept that are different from the constraints (exclude).
  */
-export declare type CommonProfessionConstraintsOperation = {
-    tag: "Intersection";
-} | {
-    tag: "Difference";
-};
+export declare enum CommonProfessionConstraintsOperation {
+    Intersection = "Intersection",
+    Difference = "Difference"
+}
 /**
  * A list of professions. The filter specifies how the list is applied to
  * all mundane professions.
@@ -156,11 +154,10 @@ export declare type CommonProfessionConstraints<Constraint> = {
 /**
  * Some professions may be found in a culture, but are not that common.
  */
-export declare type Rarity = {
-    tag: "Rare";
-} | {
-    tag: "VeryRare";
-};
+export declare enum Rarity {
+    Rare = "Rare",
+    VeryRare = "VeryRare"
+}
 export declare type ProfessionConstraint = {
     /**
      * The profession's identifier.
@@ -182,13 +179,11 @@ export declare type ProfessionConstraint = {
 /**
  * Some professions may be found in a culture, but are not that common.
  */
-export declare type MundaneProfessionSubgroupConstraint = {
-    tag: "Profane";
-} | {
-    tag: "Fighter";
-} | {
-    tag: "Religious";
-};
+export declare enum MundaneProfessionSubgroupConstraint {
+    Profane = "Profane",
+    Fighter = "Fighter",
+    Religious = "Religious"
+}
 export declare type TraditionConstraint = {
     /**
      * The magical tradition's identifier.
@@ -218,6 +213,7 @@ export declare type MagicCommonProfessionConstraint = {
     tradition: TraditionConstraint;
 } | {
     tag: "MagicDilettante";
+    magic_dilettante: {};
 } | {
     tag: "Profession";
     profession: ProfessionConstraint;

package/lib/types/Culture.js

@@ -2,4 +2,42 @@
  * @main Culture
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+/**
+ * The "weight" difference compared to other professions or profession variants.
+ * Some professions or profession variants are simply more common (Mostly), but
+ * sometimes only specific elements are used (Only).
+ */
+export var Weight;
+(function (Weight) {
+    Weight["Mostly"] = "Mostly";
+    Weight["Only"] = "Only";
+})(Weight || (Weight = {}));
+/**
+ * This defines how the list of constraints should be offset against the
+ * list of all mundane professions: Either only the professions are kept
+ * that intersect with the constraints (include) or only the professions
+ * are kept that are different from the constraints (exclude).
+ */
+export var CommonProfessionConstraintsOperation;
+(function (CommonProfessionConstraintsOperation) {
+    CommonProfessionConstraintsOperation["Intersection"] = "Intersection";
+    CommonProfessionConstraintsOperation["Difference"] = "Difference";
+})(CommonProfessionConstraintsOperation || (CommonProfessionConstraintsOperation = {}));
+/**
+ * Some professions may be found in a culture, but are not that common.
+ */
+export var Rarity;
+(function (Rarity) {
+    Rarity["Rare"] = "Rare";
+    Rarity["VeryRare"] = "VeryRare";
+})(Rarity || (Rarity = {}));
+/**
+ * Some professions may be found in a culture, but are not that common.
+ */
+export var MundaneProfessionSubgroupConstraint;
+(function (MundaneProfessionSubgroupConstraint) {
+    MundaneProfessionSubgroupConstraint["Profane"] = "Profane";
+    MundaneProfessionSubgroupConstraint["Fighter"] = "Fighter";
+    MundaneProfessionSubgroupConstraint["Religious"] = "Religious";
+})(MundaneProfessionSubgroupConstraint || (MundaneProfessionSubgroupConstraint = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/Lessons_Curriculum.d.ts

@@ -54,6 +54,7 @@ export declare type CurriculumTranslation = {
  */
 declare type ElectiveSpellworks = {
     tag: "DefinedByGameMaster";
+    defined_by_game_master: {};
 } | {
     tag: "Specific";
     specific: SpecificElectiveSpellworks;
@@ -106,10 +107,13 @@ export declare type RestrictedSpellwork = {
     spellwork: SpellworkIdentifier;
 } | {
     tag: "DemonSummoning";
+    demon_summoning: {};
 } | {
     tag: "Borbaradian";
+    borbaradian: {};
 } | {
     tag: "DamageIntelligent";
+    damage_intelligent: {};
 };
 export declare type RestrictedProperty = {
     /**

package/lib/types/Patron.d.ts

@@ -80,11 +80,10 @@ export declare type PatronCulture = {
  * only part of the given cultures. If they should differ, the patron is only
  * part of the cultures that are not given.
  */
-export declare type PatronCultureOperation = {
-    tag: "Intersection";
-} | {
-    tag: "Difference";
-};
+export declare enum PatronCultureOperation {
+    Intersection = "Intersection",
+    Difference = "Difference"
+}
 export declare type AdvantageAnimalPower = {
     /**
      * The advantage's identifier.
@@ -142,19 +141,14 @@ export declare type CombatAnimalPower = {
      */
     value: number;
 };
-export declare type CombatAnimalPowerType = {
-    tag: "Attack";
-} | {
-    tag: "Parry";
-} | {
-    tag: "RangedCombat";
-} | {
-    tag: "Dodge";
-} | {
-    tag: "DamagePoints";
-} | {
-    tag: "Protection";
-};
+export declare enum CombatAnimalPowerType {
+    Attack = "Attack",
+    Parry = "Parry",
+    RangedCombat = "RangedCombat",
+    Dodge = "Dodge",
+    DamagePoints = "DamagePoints",
+    Protection = "Protection"
+}
 export declare type AnimalPowerLevel2 = {
     tag: "Combat";
     combat: CombatAnimalPower;

package/lib/types/Patron.js

@@ -2,4 +2,24 @@
  * @main Patron
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+/**
+ * The set operation to combine the set of all patron cultures with the
+ * specified set of patron cultures: If they should intersect, the patron is
+ * only part of the given cultures. If they should differ, the patron is only
+ * part of the cultures that are not given.
+ */
+export var PatronCultureOperation;
+(function (PatronCultureOperation) {
+    PatronCultureOperation["Intersection"] = "Intersection";
+    PatronCultureOperation["Difference"] = "Difference";
+})(PatronCultureOperation || (PatronCultureOperation = {}));
+export var CombatAnimalPowerType;
+(function (CombatAnimalPowerType) {
+    CombatAnimalPowerType["Attack"] = "Attack";
+    CombatAnimalPowerType["Parry"] = "Parry";
+    CombatAnimalPowerType["RangedCombat"] = "RangedCombat";
+    CombatAnimalPowerType["Dodge"] = "Dodge";
+    CombatAnimalPowerType["DamagePoints"] = "DamagePoints";
+    CombatAnimalPowerType["Protection"] = "Protection";
+})(CombatAnimalPowerType || (CombatAnimalPowerType = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/Profession.d.ts

@@ -44,20 +44,16 @@ export declare type ProfessionGroup = {
     mundane: MundaneProfessionGroup;
 } | {
     tag: "Magical";
-    magical?: MagicalProfessionGroup;
+    magical: MagicalProfessionGroup;
 } | {
     tag: "Blessed";
+    blessed: {};
 };
-export declare type MundaneProfessionGroup = {
-    tag: "Profane";
-} | {
-    tag: "Fighter";
-} | {
-    tag: "Religious";
-};
-/**
- * @minProperties 1
- */
+export declare enum MundaneProfessionGroup {
+    Profane = "Profane",
+    Fighter = "Fighter",
+    Religious = "Religious"
+}
 export declare type MagicalProfessionGroup = {
     /**
      * The curriculum/academy associated with this magical profession, if any.
@@ -482,6 +478,7 @@ export declare type ProfessionVariantPackageOptions = {
 };
 export declare type VariantOptionAction<T> = {
     tag: "Remove";
+    remove: {};
 } | {
     tag: "Override";
     override: T;

package/lib/types/Profession.js

@@ -2,4 +2,10 @@
  * @main Profession
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+export var MundaneProfessionGroup;
+(function (MundaneProfessionGroup) {
+    MundaneProfessionGroup["Profane"] = "Profane";
+    MundaneProfessionGroup["Fighter"] = "Fighter";
+    MundaneProfessionGroup["Religious"] = "Religious";
+})(MundaneProfessionGroup || (MundaneProfessionGroup = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/Race.d.ts

@@ -185,13 +185,11 @@ export declare type WeightDice = Dice & {
  * base value. Either they are all added or subtracted or even results are
  * added and odd results are subtracted.
  */
-export declare type WeightDiceOffsetStrategy = {
-    tag: "Add";
-} | {
-    tag: "Subtract";
-} | {
-    tag: "AddEvenSubtractOdd";
-};
+export declare enum WeightDiceOffsetStrategy {
+    Add = "Add",
+    Subtract = "Subtract",
+    AddEvenSubtractOdd = "AddEvenSubtractOdd"
+}
 export declare type StartingAgeConfigForExperienceLevel = {
     /**
      * The selected experience level's identifier.

package/lib/types/Race.js

@@ -2,4 +2,15 @@
  * @main Race
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+/**
+ * The strategy how to offset the randomly generated values against the
+ * base value. Either they are all added or subtracted or even results are
+ * added and odd results are subtracted.
+ */
+export var WeightDiceOffsetStrategy;
+(function (WeightDiceOffsetStrategy) {
+    WeightDiceOffsetStrategy["Add"] = "Add";
+    WeightDiceOffsetStrategy["Subtract"] = "Subtract";
+    WeightDiceOffsetStrategy["AddEvenSubtractOdd"] = "AddEvenSubtractOdd";
+})(WeightDiceOffsetStrategy || (WeightDiceOffsetStrategy = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/Service.d.ts

@@ -27,11 +27,10 @@ export declare type Service = {
      */
     translations: LocaleMap<ServiceTranslation>;
 };
-export declare type ServiceAvailability = {
-    tag: "SummonedCreatures";
-} | {
-    tag: "Monstrosities";
-};
+export declare enum ServiceAvailability {
+    SummonedCreatures = "SummonedCreatures",
+    Monstrosities = "Monstrosities"
+}
 export declare type ServiceTranslation = {
     /**
      * The name of the service.

package/lib/types/Service.js

@@ -2,4 +2,9 @@
  * @main Service
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+export var ServiceAvailability;
+(function (ServiceAvailability) {
+    ServiceAvailability["SummonedCreatures"] = "SummonedCreatures";
+    ServiceAvailability["Monstrosities"] = "Monstrosities";
+})(ServiceAvailability || (ServiceAvailability = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/Skill.d.ts

@@ -90,13 +90,11 @@ export declare type SkillTranslation = {
  * A category. All available entries from the specified category will be
  * included as separate applications.
  */
-export declare type ApplicationCategory = {
-    tag: "BlessedTraditions";
-} | {
-    tag: "Diseases";
-} | {
-    tag: "Regions";
-};
+export declare enum ApplicationCategory {
+    BlessedTraditions = "BlessedTraditions",
+    Diseases = "Diseases",
+    Regions = "Regions"
+}
 /**
  * The skill's applications.
  */
@@ -135,11 +133,9 @@ export declare type ApplicationTranslation = {
 /**
  * Indicates whether encumbrance gives a penalty for checks with the skill.
  */
-export declare type Encumbrance = {
-    tag: "True";
-} | {
-    tag: "False";
-} | {
-    tag: "Maybe";
-};
+export declare enum Encumbrance {
+    True = "True",
+    False = "False",
+    Maybe = "Maybe"
+}
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Skill>;

package/lib/types/Skill.js

@@ -2,4 +2,23 @@
  * @main Skill
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+/**
+ * A category. All available entries from the specified category will be
+ * included as separate applications.
+ */
+export var ApplicationCategory;
+(function (ApplicationCategory) {
+    ApplicationCategory["BlessedTraditions"] = "BlessedTraditions";
+    ApplicationCategory["Diseases"] = "Diseases";
+    ApplicationCategory["Regions"] = "Regions";
+})(ApplicationCategory || (ApplicationCategory = {}));
+/**
+ * Indicates whether encumbrance gives a penalty for checks with the skill.
+ */
+export var Encumbrance;
+(function (Encumbrance) {
+    Encumbrance["True"] = "True";
+    Encumbrance["False"] = "False";
+    Encumbrance["Maybe"] = "Maybe";
+})(Encumbrance || (Encumbrance = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/Talisman.d.ts

@@ -38,17 +38,13 @@ export declare type Talisman = {
      */
     translations: LocaleMap<TalismanTranslation>;
 };
-export declare type TalismanType = {
-    tag: "MainTalisman";
-} | {
-    tag: "Talisman";
-} | {
-    tag: "MinorTalisman";
-} | {
-    tag: "Regalia";
-} | {
-    tag: "PowerfulTalisman";
-};
+export declare enum TalismanType {
+    MainTalisman = "MainTalisman",
+    Talisman = "Talisman",
+    MinorTalisman = "MinorTalisman",
+    Regalia = "Regalia",
+    PowerfulTalisman = "PowerfulTalisman"
+}
 export declare type TalismanTranslation = {
     /**
      * The name of the talisman.

package/lib/types/Talisman.js

@@ -2,4 +2,12 @@
  * @main Talisman
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+export var TalismanType;
+(function (TalismanType) {
+    TalismanType["MainTalisman"] = "MainTalisman";
+    TalismanType["Talisman"] = "Talisman";
+    TalismanType["MinorTalisman"] = "MinorTalisman";
+    TalismanType["Regalia"] = "Regalia";
+    TalismanType["PowerfulTalisman"] = "PowerfulTalisman";
+})(TalismanType || (TalismanType = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);