optolith-database-schema 0.17.0 → 0.18.1

package/CHANGELOG.md

@@ -1,6 +1,50 @@
 # Changelog
 
-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.
+All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
+
+## [0.18.1](https://github.com/elyukai/optolith-database-schema/compare/v0.18.0...v0.18.1) (2025-10-03)
+
+## [0.18.0](https://github.com/elyukai/optolith-database-schema/compare/v0.17.2...v0.18.0) (2025-10-03)
+
+
+### ⚠ BREAKING CHANGES
+
+* tsondb integration
+* use identifier object instead of plain number for publication prerequisite identifier
+* adjust naming for compiles languages that dont create namespaces per file
+* add blessed tradition type as union type
+
+### Features
+
+* add blessed tradition type as union type ([dd999c1](https://github.com/elyukai/optolith-database-schema/commit/dd999c1387d950fd27169c601f4653a1fd0273d6))
+* add skill application identifier as possible select option identifier ([2523228](https://github.com/elyukai/optolith-database-schema/commit/25232282da57baf82d369bc80be703ae69df6f6d))
+* add translation strings for prerequisites ([a031ad9](https://github.com/elyukai/optolith-database-schema/commit/a031ad93ea305c831fbb52498adecec3f9b3b2e1))
+* adjust naming for compiles languages that dont create namespaces per file ([4236fa3](https://github.com/elyukai/optolith-database-schema/commit/4236fa38040bf034d27e942e66647462a1e15f3c))
+* **swift:** add initializers to all structs ([fc79950](https://github.com/elyukai/optolith-database-schema/commit/fc79950428c62f0ca11d56299854f83a37d693c8))
+* **swift:** add set of available locales and documentation for LocaleMap ([c247c06](https://github.com/elyukai/optolith-database-schema/commit/c247c067e4b38cf8b748fe1ab1228ecbf294b8cc))
+* **swift:** do not generate ignored files ([6dd361a](https://github.com/elyukai/optolith-database-schema/commit/6dd361a16cea4488b4d7d34a86edbf673ea97d4b))
+* **swift:** remove generation date header comment ([9db2fd5](https://github.com/elyukai/optolith-database-schema/commit/9db2fd59894a692a8443592e8247251f55913e73))
+* tsondb integration ([619805c](https://github.com/elyukai/optolith-database-schema/commit/619805ccfb3771962cc5e987f80b51a5dcf56c09)), closes [#35](https://github.com/elyukai/optolith-database-schema/issues/35)
+
+
+### Bug Fixes
+
+* **swift:** add ignored LocaleMap type ([f80bbaa](https://github.com/elyukai/optolith-database-schema/commit/f80bbaa8289c9053ae31867564a072cf7bd506a0))
+* **swift:** identifier objects' initializers must be public ([8f2be47](https://github.com/elyukai/optolith-database-schema/commit/8f2be474440a00c37d4aee8f6eb4cceba2dbf8ee))
+* **swift:** LocaleMap initializer didnt initialize all properties ([f5167bb](https://github.com/elyukai/optolith-database-schema/commit/f5167bb56586e88d970cf893e5ea077bc41e1113))
+* **swift:** remove unnecessary indentation in empty lines ([dbe1902](https://github.com/elyukai/optolith-database-schema/commit/dbe19027a05a9834fc00cc2fcb1892fca1fd74fe))
+* use identifier object instead of plain number for publication prerequisite identifier ([bb7a688](https://github.com/elyukai/optolith-database-schema/commit/bb7a688b019fc95070bb7aaf4246a6d64d0de91a))
+
+### [0.17.2](https://github.com/elyukai/optolith-database-schema/compare/v0.17.1...v0.17.2) (2024-10-06)
+
+### [0.17.1](https://github.com/elyukai/optolith-database-schema/compare/v0.17.0...v0.17.1) (2024-10-06)
+
+
+### Features
+
+* add minimum and maximum UI strings with placeholders ([1bf8df1](https://github.com/elyukai/optolith-database-schema/commit/1bf8df1575c605b50d2990ed5cd85892d871ecba))
+* add pluralization type definitions ([a8340e6](https://github.com/elyukai/optolith-database-schema/commit/a8340e6dd488945b63347a80de0f54f5eb5050e8))
+* use @optolith/helpers package ([d8324f7](https://github.com/elyukai/optolith-database-schema/commit/d8324f7042f459201452704bffa3c06e1ec582fe))
 
 ## [0.17.0](https://github.com/elyukai/optolith-database-schema/compare/v0.16.8...v0.17.0) (2024-10-03)
 

package/lib/main.d.ts

@@ -1,101 +1,2 @@
-import type { Options as AjvOptions } from "ajv";
-import { CacheMap } from "./config/cache.js";
-import { TypeId, TypeMap } from "./config/types.js";
-import "./helpers/array.js";
-import { Result } from "./helpers/result.js";
-import { IntegrityError } from "./validation/builders/integrity.js";
-import { FileNameError } from "./validation/builders/naming.js";
-import { SchemaError } from "./validation/builders/schema.js";
-import { TypeValidationResult } from "./validation/raw.js";
-/**
- * Options for validating data files.
- */
-export type ValidationOptions = {
-    /**
-     * Whether to check the integrity of the data files. This includes checking
-     * for referencial integrity (i.e. whether all referenced entities exist).
-     * @default false
-     */
-    checkIntegrity?: boolean;
-    /**
-     * Ajv instance options. See https://ajv.js.org/options.html.
-     */
-    ajvOptions?: AjvOptions;
-};
-/**
- * A type validation may fail because of the data not matching the schema, the
- * file name not matching a pattern, or integrity issues.
- */
-export type TypeValidationError = IntegrityError | FileNameError | SchemaError;
-/**
- * A map of all valid entries, grouped by entity type.
- */
-export type ValidResults = {
-    [K in keyof TypeMap]: [id: TypeId<K>, data: TypeMap[K]][];
-};
-/**
- * A map of all entries, grouped by entity type.
- */
-export type RawResults = {
-    [K in keyof TypeMap]: TypeValidationResult<K>[];
-};
-/**
- * A dictionary of entity types and their data’s associated locations.
- */
-export type EntityDirectoryPaths = {
-    [K in keyof TypeMap]: string;
-};
-type StrictResults = Result<ValidResults, Record<string, TypeValidationError[]>>;
-/**
- * If the database has no validation issues, returns the whole data set as a map
- * of entity types to their data. If there are any errors, only the errors will
- * be returned instead.
- * @param entityDirPaths THe paths to the directories containing the data to be
- * validated.
- * @param options Configuration options for the validation.
- * @returns Either the whole data set or the errors.
- */
-export declare const getAllValidDataOrErrors: (entityDirPaths: EntityDirectoryPaths, options?: ValidationOptions) => Promise<StrictResults>;
-/**
- * Returns all valid data as a map of entity types to their data.
- * @param entityDirPaths THe paths to the directories containing the data to be
- * validated.
- * @param options Configuration options for the validation.
- * @returns The valid data.
- */
-export declare const getAllValidData: (entityDirPaths: EntityDirectoryPaths, options?: ValidationOptions) => Promise<ValidResults>;
-/**
- * Returns all data as a map of entity types to their validation results.
- * @param entityDirPaths THe paths to the directories containing the data to be
- * validated.
- * @param options Configuration options for the validation.
- * @returns The validation results.
- */
-export declare const getRawResults: (entityDirPaths: EntityDirectoryPaths, options?: ValidationOptions) => Promise<RawResults>;
-/**
- * A dictionary of cache types and their associated location.
- */
-export type CachePaths = {
-    [K in keyof CacheMap]: string;
-};
-export type CacheOptions = {
-    /**
-     * Whether to pretty-print the JSON. Default is `false`.
-     */
-    pretty?: boolean;
-};
-/**
- * Builds the cache and writes it to the specified paths in JSON format.
- * @param cachePaths The absolute paths to write each cache to.
- * @param validResults The data to build the cache from. Usually the result of
- * `getAllValidData`.
- * @param options Configuration options for building the cache.
- */
-export declare const buildCache: (cachePaths: CachePaths, validResults: ValidResults, options?: CacheOptions) => Promise<void>;
-/**
- * Reads the cache from the specified paths in JSON format.
- * @param cachePaths The absolute paths to read each cache from.
- * @returns
- */
-export declare const getCache: (cachePaths: CachePaths) => Promise<CacheMap>;
-export {};
+import { Schema } from "tsondb/schema";
+export declare const schema: Schema;

package/lib/main.js

@@ -1,106 +1,361 @@
-import { mkdir, readFile, writeFile } from "node:fs/promises";
-import { dirname } from "node:path";
-import { cacheMap } from "./config/cache.js";
-import "./helpers/array.js";
-import { mapSecond } from "./helpers/pair.js";
-import { Result, error, isError, isOk, ok } from "./helpers/result.js";
-import { getRawValidationResults, } from "./validation/raw.js";
-const rawResultMapToResult = (rawResultMap) => rawResultMap.reduce((result, [typeName, typeResults]) => typeResults.reduce((outerResult, [filePath, fileResult]) => {
-    if (isOk(outerResult) && isOk(fileResult)) {
-        return ok({
-            ...outerResult.value,
-            [typeName]: [...(outerResult.value[typeName] ?? []), fileResult.value],
-        });
-    }
-    else if (isOk(outerResult) && isError(fileResult)) {
-        return error({
-            [filePath]: fileResult.error,
-        });
-    }
-    else if (isError(outerResult) && isError(fileResult)) {
-        return error({
-            ...outerResult.error,
-            [filePath]: fileResult.error,
-        });
-    }
-    else {
-        return outerResult;
-    }
-}, result), ok({}));
-const filterResultMapByValidData = (rawResultMap) => rawResultMap
-    .map(mapSecond((typeResults) => typeResults
-    .filter((typeResult) => Result.isOk(typeResult[1]))
-    .map(fileResult => fileResult[1].value)))
-    .objectFromEntries();
-/**
- * If the database has no validation issues, returns the whole data set as a map
- * of entity types to their data. If there are any errors, only the errors will
- * be returned instead.
- * @param entityDirPaths THe paths to the directories containing the data to be
- * validated.
- * @param options Configuration options for the validation.
- * @returns Either the whole data set or the errors.
- */
-export const getAllValidDataOrErrors = async (entityDirPaths, options = {}) => {
-    const rawResultMap = await getRawValidationResults(entityDirPaths, options);
-    return rawResultMapToResult(rawResultMap);
-};
-/**
- * Returns all valid data as a map of entity types to their data.
- * @param entityDirPaths THe paths to the directories containing the data to be
- * validated.
- * @param options Configuration options for the validation.
- * @returns The valid data.
- */
-export const getAllValidData = async (entityDirPaths, options = {}) => {
-    const rawResultMap = await getRawValidationResults(entityDirPaths, options);
-    return filterResultMapByValidData(rawResultMap);
-};
-/**
- * Returns all data as a map of entity types to their validation results.
- * @param entityDirPaths THe paths to the directories containing the data to be
- * validated.
- * @param options Configuration options for the validation.
- * @returns The validation results.
- */
-export const getRawResults = async (entityDirPaths, options = {}) => {
-    const rawResultMap = await getRawValidationResults(entityDirPaths, options);
-    return Object.fromEntries(rawResultMap);
-};
-/**
- * Builds the cache and writes it to the specified paths in JSON format.
- * @param cachePaths The absolute paths to write each cache to.
- * @param validResults The data to build the cache from. Usually the result of
- * `getAllValidData`.
- * @param options Configuration options for building the cache.
- */
-export const buildCache = async (cachePaths, validResults, options = {}) => {
-    const { pretty = false } = options;
-    const activatableSelectOptionsCache = cacheMap.activatableSelectOptions.builder(validResults);
-    const ancestorBloodAdvantagesCache = cacheMap.ancestorBloodAdvantages.builder(validResults);
-    const magicalAndBlessedAdvantagesAndDisadvantagesCache = cacheMap.magicalAndBlessedAdvantagesAndDisadvantages.builder(validResults);
-    const newApplicationsAndUsesCache = cacheMap.newApplicationsAndUses.builder(validResults, activatableSelectOptionsCache);
-    const cacheData = {
-        activatableSelectOptions: activatableSelectOptionsCache,
-        ancestorBloodAdvantages: ancestorBloodAdvantagesCache,
-        magicalAndBlessedAdvantagesAndDisadvantages: magicalAndBlessedAdvantagesAndDisadvantagesCache,
-        newApplicationsAndUses: newApplicationsAndUsesCache,
-    };
-    for (const [cacheName, cachePath] of Object.entries(cachePaths)) {
-        await mkdir(dirname(cachePath), { recursive: true });
-        await writeFile(cachePath, JSON.stringify(cacheData[cacheName], null, pretty ? 2 : undefined), "utf-8");
-    }
-};
-/**
- * Reads the cache from the specified paths in JSON format.
- * @param cachePaths The absolute paths to read each cache from.
- * @returns
- */
-export const getCache = async (cachePaths) => {
-    const cache = {};
-    for (const [cacheName, cachePath] of Object.entries(cachePaths)) {
-        const cacheData = JSON.parse(await readFile(cachePath, "utf-8"));
-        cache[cacheName] = cacheData;
-    }
-    return cache;
-};
+import { Schema } from "tsondb/schema";
+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";
+import { Attribute } from "./types/Attribute.js";
+import { Blessing } from "./types/Blessing.js";
+import { Cantrip } from "./types/Cantrip.js";
+import { Ceremony } from "./types/Ceremony.js";
+import { CloseCombatTechnique, RangedCombatTechnique } from "./types/CombatTechnique.js";
+import { Condition } from "./types/Condition.js";
+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 { ExperienceLevel } from "./types/ExperienceLevel.js";
+import { EyeColor } from "./types/EyeColor.js";
+import { FamiliarsTrick } from "./types/FamiliarsTrick.js";
+import { HairColor } from "./types/HairColor.js";
+import { Curriculum, Guideline } from "./types/Lessons.js";
+import { LiturgicalChant } from "./types/LiturgicalChant.js";
+import { Locale } from "./types/Locale.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 { Service } from "./types/Service.js";
+import { SexPractice } from "./types/SexPractice.js";
+import { Skill } from "./types/Skill.js";
+import { SkillGroup } from "./types/SkillGroup.js";
+import { SkillModificationLevel } from "./types/SkillModificationLevel.js";
+import { SocialStatus } from "./types/SocialStatus.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 { EquipmentPackage } from "./types/equipment/EquipmentPackage.js";
+import { Ammunition } from "./types/equipment/item/Ammunition.js";
+import { Animal } from "./types/equipment/item/Animal.js";
+import { AnimalCare } from "./types/equipment/item/AnimalCare.js";
+import { Armor } from "./types/equipment/item/Armor.js";
+import { BandageOrRemedy } from "./types/equipment/item/BandageOrRemedy.js";
+import { Book } from "./types/equipment/item/Book.js";
+import { CeremonialItem } from "./types/equipment/item/CeremonialItem.js";
+import { Clothes } from "./types/equipment/item/Clothes.js";
+import { Container } from "./types/equipment/item/Container.js";
+import { Elixir } from "./types/equipment/item/Elixir.js";
+import { EquipmentOfBlessedOnes } from "./types/equipment/item/EquipmentOfBlessedOnes.js";
+import { GemOrPreciousStone } from "./types/equipment/item/GemOrPreciousStone.js";
+import { IlluminationLightSource } from "./types/equipment/item/IlluminationLightSource.js";
+import { IlluminationRefillOrSupply } from "./types/equipment/item/IlluminationRefillOrSupply.js";
+import { Jewelry } from "./types/equipment/item/Jewelry.js";
+import { Liebesspielzeug } from "./types/equipment/item/Liebesspielzeug.js";
+import { LuxuryGood } from "./types/equipment/item/LuxuryGood.js";
+import { MagicalArtifact } from "./types/equipment/item/MagicalArtifact.js";
+import { MusicalInstrument } from "./types/equipment/item/MusicalInstrument.js";
+import { OrienteeringAid } from "./types/equipment/item/OrienteeringAid.js";
+import { Poison } from "./types/equipment/item/Poison.js";
+import { RopeOrChain } from "./types/equipment/item/RopeOrChain.js";
+import { Stationery } from "./types/equipment/item/Stationery.js";
+import { ThievesTool } from "./types/equipment/item/ThievesTool.js";
+import { ToolOfTheTrade } from "./types/equipment/item/ToolOfTheTrade.js";
+import { TravelGearOrTool } from "./types/equipment/item/TravelGearOrTool.js";
+import { Vehicle } from "./types/equipment/item/Vehicle.js";
+import { Weapon } from "./types/equipment/item/Weapon.js";
+import { WeaponAccessory } from "./types/equipment/item/WeaponAccessory.js";
+import { ArmorType } from "./types/equipment/item/sub/ArmorType.js";
+import { Reach } from "./types/equipment/item/sub/Reach.js";
+import { AnimistPower } from "./types/magicalActions/AnimistPower.js";
+import { Tribe } from "./types/magicalActions/AnimistPower_Tribe.js";
+import { Curse } from "./types/magicalActions/Curse.js";
+import { DominationRitual } from "./types/magicalActions/DominationRitual.js";
+import { ElvenMagicalSong } from "./types/magicalActions/ElvenMagicalSong.js";
+import { GeodeRitual } from "./types/magicalActions/GeodeRitual.js";
+import { JesterTrick } from "./types/magicalActions/JesterTrick.js";
+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 { 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";
+import { Publication } from "./types/source/Publication.js";
+import { AdvancedCombatSpecialAbility } from "./types/specialAbility/AdvancedCombatSpecialAbility.js";
+import { AdvancedKarmaSpecialAbility } from "./types/specialAbility/AdvancedKarmaSpecialAbility.js";
+import { AdvancedMagicalSpecialAbility } from "./types/specialAbility/AdvancedMagicalSpecialAbility.js";
+import { AdvancedSkillSpecialAbility } from "./types/specialAbility/AdvancedSkillSpecialAbility.js";
+import { AncestorGlyph } from "./types/specialAbility/AncestorGlyph.js";
+import { BlessedTradition } from "./types/specialAbility/BlessedTradition.js";
+import { BrawlingSpecialAbility } from "./types/specialAbility/BrawlingSpecialAbility.js";
+import { CeremonialItemSpecialAbility } from "./types/specialAbility/CeremonialItemSpecialAbility.js";
+import { CombatSpecialAbility } from "./types/specialAbility/CombatSpecialAbility.js";
+import { CombatStyleSpecialAbility } from "./types/specialAbility/CombatStyleSpecialAbility.js";
+import { CommandSpecialAbility } from "./types/specialAbility/CommandSpecialAbility.js";
+import { FamiliarSpecialAbility } from "./types/specialAbility/FamiliarSpecialAbility.js";
+import { FatePointSexSpecialAbility } from "./types/specialAbility/FatePointSexSpecialAbility.js";
+import { FatePointSpecialAbility } from "./types/specialAbility/FatePointSpecialAbility.js";
+import { GeneralSpecialAbility } from "./types/specialAbility/GeneralSpecialAbility.js";
+import { KarmaSpecialAbility } from "./types/specialAbility/KarmaSpecialAbility.js";
+import { LiturgicalStyleSpecialAbility } from "./types/specialAbility/LiturgicalStyleSpecialAbility.js";
+import { LycantropicGift } from "./types/specialAbility/LycantropicGift.js";
+import { MagicStyleSpecialAbility } from "./types/specialAbility/MagicStyleSpecialAbility.js";
+import { MagicalSign } from "./types/specialAbility/MagicalSign.js";
+import { MagicalSpecialAbility } from "./types/specialAbility/MagicalSpecialAbility.js";
+import { MagicalTradition } from "./types/specialAbility/MagicalTradition.js";
+import { PactGift } from "./types/specialAbility/PactGift.js";
+import { ProtectiveWardingCircleSpecialAbility } from "./types/specialAbility/ProtectiveWardingCircleSpecialAbility.js";
+import { Sermon } from "./types/specialAbility/Sermon.js";
+import { SexSpecialAbility } from "./types/specialAbility/SexSpecialAbility.js";
+import { SikaryanDrainSpecialAbility } from "./types/specialAbility/SikaryanDrainSpecialAbility.js";
+import { SkillStyleSpecialAbility } from "./types/specialAbility/SkillStyleSpecialAbility.js";
+import { VampiricGift } from "./types/specialAbility/VampiricGift.js";
+import { Vision } from "./types/specialAbility/Vision.js";
+import { Language } from "./types/specialAbility/sub/Language.js";
+import { Script } from "./types/specialAbility/sub/Script.js";
+import { TradeSecret } from "./types/specialAbility/sub/TradeSecret.js";
+import { ArcaneOrbEnchantment } from "./types/traditionArtifacts/ArcaneOrbEnchantment.js";
+import { AttireEnchantment } from "./types/traditionArtifacts/AttireEnchantment.js";
+import { BowlEnchantment } from "./types/traditionArtifacts/BowlEnchantment.js";
+import { CauldronEnchantment } from "./types/traditionArtifacts/CauldronEnchantment.js";
+import { ChronicleEnchantment } from "./types/traditionArtifacts/ChronicleEnchantment.js";
+import { DaggerRitual } from "./types/traditionArtifacts/DaggerRitual.js";
+import { FoolsHatEnchantment } from "./types/traditionArtifacts/FoolsHatEnchantment.js";
+import { InstrumentEnchantment } from "./types/traditionArtifacts/InstrumentEnchantment.js";
+import { Krallenkettenzauber } from "./types/traditionArtifacts/Krallenkettenzauber.js";
+import { OrbEnchantment } from "./types/traditionArtifacts/OrbEnchantment.js";
+import { RingEnchantment } from "./types/traditionArtifacts/RingEnchantment.js";
+import { SickleRitual } from "./types/traditionArtifacts/SickleRitual.js";
+import { SpellSwordEnchantment } from "./types/traditionArtifacts/SpellSwordEnchantment.js";
+import { StaffEnchantment } from "./types/traditionArtifacts/StaffEnchantment.js";
+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 { AnimalShape } from "./types/traditionArtifacts/sub/AnimalShape.js";
+import { AnimalShapePath } from "./types/traditionArtifacts/sub/AnimalShapePath.js";
+import { AnimalShapeSize } from "./types/traditionArtifacts/sub/AnimalShapeSize.js";
+import { Brew } from "./types/traditionArtifacts/sub/Brew.js";
+export const schema = Schema([
+    AdvancedCombatSpecialAbility,
+    AdvancedKarmaSpecialAbility,
+    AdvancedMagicalSpecialAbility,
+    AdvancedSkillSpecialAbility,
+    Advantage,
+    Ammunition,
+    AncestorGlyph,
+    AnimalCare,
+    AnimalDisease,
+    Animal,
+    AnimalShapePath,
+    AnimalShape,
+    AnimalShapeSize,
+    AnimalType,
+    AnimistPower,
+    Tribe,
+    ArcaneBardTradition,
+    ArcaneDancerTradition,
+    ArcaneOrbEnchantment,
+    Armor,
+    ArmorType,
+    Aspect,
+    AttireEnchantment,
+    Attribute,
+    BandageOrRemedy,
+    BlessedTradition,
+    Blessing,
+    Book,
+    BowlEnchantment,
+    BrawlingSpecialAbility,
+    Brew,
+    Cantrip,
+    CauldronEnchantment,
+    CeremonialItem,
+    CeremonialItemSpecialAbility,
+    Ceremony,
+    ChronicleEnchantment,
+    CloseCombatTechnique,
+    Clothes,
+    CombatSpecialAbility,
+    CombatStyleSpecialAbility,
+    CommandSpecialAbility,
+    Condition,
+    Container,
+    Continent,
+    CoreRule,
+    Culture,
+    Curse,
+    DaggerRitual,
+    DerivedCharacteristic,
+    Disadvantage,
+    Disease,
+    DominationRitual,
+    Element,
+    Elixir,
+    ElvenMagicalSong,
+    EquipmentOfBlessedOnes,
+    EquipmentPackage,
+    ExperienceLevel,
+    EyeColor,
+    FamiliarSpecialAbility,
+    FamiliarsTrick,
+    FatePointSexSpecialAbility,
+    FatePointSpecialAbility,
+    FocusRule,
+    Subject,
+    FoolsHatEnchantment,
+    GemOrPreciousStone,
+    GeneralSpecialAbility,
+    GeodeRitual,
+    HairColor,
+    IlluminationLightSource,
+    IlluminationRefillOrSupply,
+    InstrumentEnchantment,
+    JesterTrick,
+    Jewelry,
+    KarmaSpecialAbility,
+    Krallenkettenzauber,
+    Language,
+    Curriculum,
+    Guideline,
+    Liebesspielzeug,
+    LiturgicalChant,
+    LiturgicalStyleSpecialAbility,
+    LuxuryGood,
+    LycantropicGift,
+    MagicalArtifact,
+    MagicalDance,
+    MagicalMelody,
+    MagicalRune,
+    MagicalSign,
+    MagicalSpecialAbility,
+    MagicalTradition,
+    MagicStyleSpecialAbility,
+    MetaCondition,
+    MusicalInstrument,
+    OptionalRule,
+    OrbEnchantment,
+    OrienteeringAid,
+    PactCategory,
+    PactGift,
+    PatronCategory,
+    Patron,
+    PersonalityTrait,
+    Poison,
+    Profession,
+    Property,
+    ProtectiveWardingCircleSpecialAbility,
+    Publication,
+    Race,
+    RangedCombatTechnique,
+    Reach,
+    Region,
+    RingEnchantment,
+    Ritual,
+    RopeOrChain,
+    Script,
+    Sermon,
+    Service,
+    SexPractice,
+    SexSpecialAbility,
+    SickleRitual,
+    SikaryanDrainSpecialAbility,
+    SkillGroup,
+    SkillModificationLevel,
+    Skill,
+    SkillStyleSpecialAbility,
+    SocialStatus,
+    Spell,
+    SpellSwordEnchantment,
+    StaffEnchantment,
+    State,
+    Stationery,
+    Talisman,
+    TargetCategory,
+    ThievesTool,
+    ToolOfTheTrade,
+    ToyEnchantment,
+    TradeSecret,
+    TravelGearOrTool,
+    Trinkhornzauber,
+    VampiricGift,
+    Vehicle,
+    Vision,
+    WandEnchantment,
+    WeaponAccessory,
+    WeaponEnchantment,
+    Weapon,
+    ZibiljaRitual,
+], Locale);
+// /**
+//  * A dictionary of cache types and their associated location.
+//  */
+// export type CachePaths = {
+//   [K in keyof CacheMap]: string
+// }
+// export type CacheOptions = {
+//   /**
+//    * Whether to pretty-print the JSON. Default is `false`.
+//    */
+//   pretty?: boolean
+// }
+// /**
+//  * Builds the cache and writes it to the specified paths in JSON format.
+//  * @param cachePaths The absolute paths to write each cache to.
+//  * @param validResults The data to build the cache from. Usually the result of
+//  * `getAllValidData`.
+//  * @param options Configuration options for building the cache.
+//  */
+// export const buildCache = async (
+//   cachePaths: CachePaths,
+//   validResults: ValidResults,
+//   options: CacheOptions = {}
+// ): Promise<void> => {
+//   const { pretty = false } = options
+//   const activatableSelectOptionsCache = cacheMap.activatableSelectOptions.builder(validResults)
+//   const ancestorBloodAdvantagesCache = cacheMap.ancestorBloodAdvantages.builder(validResults)
+//   const magicalAndBlessedAdvantagesAndDisadvantagesCache =
+//     cacheMap.magicalAndBlessedAdvantagesAndDisadvantages.builder(validResults)
+//   const newApplicationsAndUsesCache = cacheMap.newApplicationsAndUses.builder(
+//     validResults,
+//     activatableSelectOptionsCache
+//   )
+//   const cacheData: CacheMap = {
+//     activatableSelectOptions: activatableSelectOptionsCache,
+//     ancestorBloodAdvantages: ancestorBloodAdvantagesCache,
+//     magicalAndBlessedAdvantagesAndDisadvantages: magicalAndBlessedAdvantagesAndDisadvantagesCache,
+//     newApplicationsAndUses: newApplicationsAndUsesCache,
+//   }
+//   for (const [cacheName, cachePath] of Object.entries(cachePaths)) {
+//     await mkdir(dirname(cachePath), { recursive: true })
+//     await writeFile(
+//       cachePath,
+//       JSON.stringify(cacheData[cacheName as keyof CachePaths], null, pretty ? 2 : undefined),
+//       "utf-8"
+//     )
+//   }
+// }
+// /**
+//  * Reads the cache from the specified paths in JSON format.
+//  * @param cachePaths The absolute paths to read each cache from.
+//  * @returns
+//  */
+// export const getCache = async (cachePaths: CachePaths): Promise<CacheMap> => {
+//   const cache: Partial<CacheMap> = {}
+//   for (const [cacheName, cachePath] of Object.entries(cachePaths)) {
+//     const cacheData = JSON.parse(await readFile(cachePath, "utf-8"))
+//     cache[cacheName as keyof CacheMap] = cacheData
+//   }
+//   return cache as CacheMap
+// }

package/lib/test.d.ts

@@ -0,0 +1 @@
+import "./main.js";

package/lib/test.js

@@ -0,0 +1,2 @@
+// importing the main file will run the schema checks
+import "./main.js";