optolith-database-schema 0.11.4 → 0.11.6

package/lib/types/specialAbility/SexSpecialAbility.js

@@ -0,0 +1,12 @@
+/**
+ * @main SexSpecialAbility
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "SexSpecialAbility",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("SexSpecialAbility"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/specialAbility/SikaryanDrainSpecialAbility.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @main SikaryanDrainSpecialAbility
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Sikaryan Drain Special Ability
+ */
+export type SikaryanDrainSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<SikaryanDrainSpecialAbilityTranslation>;
+};
+export type SikaryanDrainSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    /**
+     * The AP value. It is only used if the text cannot be generated from the
+     * given information.
+     */
+    ap_value?: Activatable.AdventurePointsValueReplacement;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<SikaryanDrainSpecialAbility>;

package/lib/types/specialAbility/SikaryanDrainSpecialAbility.js

@@ -0,0 +1,12 @@
+/**
+ * @main SikaryanDrainSpecialAbility
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "SikaryanDrainSpecialAbility",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("SikaryanDrainSpecialAbility"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/specialAbility/SkillStyleSpecialAbility.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @main SkillStyleSpecialAbility
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { AdvancedSkillSpecialAbilityIdentifier } from "../_Identifier.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Skill Style Special Ability
+ */
+export type SkillStyleSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    maximum?: Activatable.Maximum;
+    advanced: Activatable.AdvancedSpecialAbilities<AdvancedSkillSpecialAbilityIdentifier>;
+    prerequisites?: GeneralPrerequisites;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<SkillStyleSpecialAbilityTranslation>;
+};
+export type SkillStyleSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<SkillStyleSpecialAbility>;

package/lib/types/specialAbility/SkillStyleSpecialAbility.js

@@ -0,0 +1,12 @@
+/**
+ * @main SkillStyleSpecialAbility
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "SkillStyleSpecialAbility",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("SkillStyleSpecialAbility"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/specialAbility/VampiricGift.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @main VampiricGift
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Vampiric Gift
+ */
+export type VampiricGift = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<VampiricGiftTranslation>;
+};
+export type VampiricGiftTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    /**
+     * The AP value. It is only used if the text cannot be generated from the
+     * given information.
+     */
+    ap_value?: Activatable.AdventurePointsValueReplacement;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<VampiricGift>;

package/lib/types/specialAbility/VampiricGift.js

@@ -0,0 +1,12 @@
+/**
+ * @main VampiricGift
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "VampiricGift",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("VampiricGift"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/specialAbility/Vision.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @main Vision
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Vision
+ */
+export type Vision = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<VisionTranslation>;
+};
+export type VisionTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<Vision>;

package/lib/types/specialAbility/Vision.js

@@ -0,0 +1,12 @@
+/**
+ * @main Vision
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "Vision",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Vision"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/specialAbility/_Tradition.d.ts

@@ -0,0 +1,12 @@
+import { NonEmptyString } from "../_NonEmptyString.js";
+export type SpecialRule = {
+    /**
+     * An optional label that is displayed and placed before the actual
+     * text.
+     */
+    label?: NonEmptyString;
+    /**
+     * The text of a special rule.
+     */
+    text: NonEmptyString;
+};

package/lib/types/specialAbility/_Tradition.js

@@ -0,0 +1 @@
+export {};

package/lib/types/specialAbility/sub/Language.d.ts

@@ -0,0 +1,117 @@
+/**
+ * @main Language
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { AlternativeName } from "../../_AlternativeNames.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyString } from "../../_NonEmptyString.js";
+import { LanguagePrerequisites } from "../../_Prerequisite.js";
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { AssociatedContinent } from "./_LanguageScript.js";
+/**
+ * @title Language
+ */
+export type Language = {
+    /**
+     * The language's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The continents this language is present on.
+     * @minItems 1
+     */
+    continent: AssociatedContinent[];
+    /**
+     * Language-specific specializations. Either a list of possible options or a
+     * indefinite description of what may be a specialization.
+     */
+    specializations?: Specializations;
+    prerequisites?: LanguagePrerequisites;
+    /**
+     * The maximum possible level of the language. Only specified if lower than
+     * default of 3.
+     * @minimum 1
+     * @maximum 2
+     * @default 3
+     */
+    max_level?: number;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<LanguageTranslation>;
+};
+export type Specializations = {
+    tag: "Specific";
+    specific: SpecificSpecializations;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteSpecializations;
+};
+export type SpecificSpecializations = {
+    /**
+     * A list of specific possible specializations.
+     * @minItems 1
+     */
+    list: SpecificSpecialization[];
+};
+export type SpecificSpecialization = {
+    /**
+     * The specialization's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<SpecificSpecializationTranslation>;
+};
+export type SpecificSpecializationTranslation = {
+    /**
+     * The name of the specialization.
+     */
+    name: NonEmptyString;
+    /**
+     * The specialization description. It will be appended to the name in
+     * parenthesis.
+     */
+    description?: NonEmptyString;
+};
+export type IndefiniteSpecializations = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteSpecializationsTranslation>;
+};
+export type IndefiniteSpecializationsTranslation = {
+    /**
+     * The specializations description.
+     */
+    description: NonEmptyString;
+    /**
+     * An input label or placeholder text for an UI element if it differs
+     * from the `description`.
+     */
+    label?: NonEmptyString;
+};
+export type LanguageTranslation = {
+    /**
+     * The name of the language.
+     */
+    name: NonEmptyString;
+    /**
+     * A list of alternative names.
+     * @minItems 1
+     */
+    alternative_names?: AlternativeName[];
+    /**
+     * The description of the language.
+     */
+    description?: NonEmptyString;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<Language>;

package/lib/types/specialAbility/sub/Language.js

@@ -0,0 +1,12 @@
+/**
+ * @main Language
+ */
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export const config = {
+    name: "Language",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Language"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/specialAbility/sub/Script.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @main Script
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { AlternativeName } from "../../_AlternativeNames.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyString } from "../../_NonEmptyString.js";
+import { LanguageReference } from "../../_SimpleReferences.js";
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+import { AssociatedContinent } from "./_LanguageScript.js";
+/**
+ * @title Script
+ */
+export type Script = {
+    /**
+     * The script's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The script's adventure point value.
+     * @integer
+     * @minimum 2
+     * @multipleOf 2
+     */
+    ap_value: number;
+    /**
+     * A list of languages that use this script.
+     */
+    associated_languages: LanguageReference[];
+    /**
+     * The continents this script is present on.
+     * @minItems 1
+     */
+    continent: AssociatedContinent[];
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ScriptTranslation>;
+};
+export type ScriptTranslation = {
+    /**
+     * The name of the language.
+     */
+    name: NonEmptyString;
+    /**
+     * A list of alternative names.
+     * @minItems 1
+     */
+    alternative_names?: AlternativeName[];
+    /**
+     * The description of the alphabet.
+     */
+    alphabet?: NonEmptyString;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<Script>;

package/lib/types/specialAbility/sub/Script.js

@@ -0,0 +1,12 @@
+/**
+ * @main Script
+ */
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export const config = {
+    name: "Script",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Script"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/specialAbility/sub/TradeSecret.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @main TradeSecret
+ */
+import { TypeConfig } from "../../../typeConfig.js";
+import { LocaleMap } from "../../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../../_NonEmptyString.js";
+import { GeneralPrerequisites } from "../../_Prerequisite.js";
+import { Errata } from "../../source/_Erratum.js";
+import { PublicationRefs } from "../../source/_PublicationRef.js";
+/**
+ * @title Trade Secret
+ */
+export type TradeSecret = {
+    /**
+     * The trade secret's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The adventure points value of the trade secret.
+     * @integer
+     * @minimum 1
+     */
+    ap_value: number;
+    /**
+     * Is this trade secret considered secret knowledge?
+     */
+    is_secret_knowledge: boolean;
+    prerequisites?: GeneralPrerequisites;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<TradeSecretTranslation>;
+};
+export type TradeSecretTranslation = {
+    /**
+     * The name of the trade secret.
+     */
+    name: NonEmptyString;
+    /**
+     * The description of the trade secret.
+     */
+    description?: NonEmptyMarkdown;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<TradeSecret>;

package/lib/types/specialAbility/sub/TradeSecret.js

@@ -0,0 +1,12 @@
+/**
+ * @main TradeSecret
+ */
+import { todo } from "../../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../../validation/filename.js";
+export const config = {
+    name: "TradeSecret",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("TradeSecret"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/specialAbility/sub/_LanguageScript.d.ts

@@ -0,0 +1,11 @@
+import { ContinentIdentifier } from "../../_Identifier.js";
+export type AssociatedContinent = {
+    /**
+     * The continent's identifier.
+     */
+    id: ContinentIdentifier;
+    /**
+     * Is the language considered virtually extinct in this continent?
+     */
+    is_extinct: boolean;
+};

package/lib/types/specialAbility/sub/_LanguageScript.js

@@ -0,0 +1 @@
+export {};

package/lib/types/traditionArtifacts/ArcaneOrbEnchantment.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @main ArcaneOrbEnchantment
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Arcane Orb Enchantment
+ */
+export type ArcaneOrbEnchantment = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
+    volume: Activatable.Volume;
+    cost?: Activatable.EnchantmentCost;
+    property: Activatable.Property;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<ArcaneOrbEnchantmentTranslation>;
+};
+export type ArcaneOrbEnchantmentTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<ArcaneOrbEnchantment>;

package/lib/types/traditionArtifacts/ArcaneOrbEnchantment.js

@@ -0,0 +1,12 @@
+/**
+ * @main ArcaneOrbEnchantment
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "ArcaneOrbEnchantment",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("ArcaneOrbEnchantment"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

package/lib/types/traditionArtifacts/AttireEnchantment.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @main AttireEnchantment
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Attire Enchantment
+ */
+export type AttireEnchantment = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
+    volume: Activatable.Volume;
+    cost?: Activatable.EnchantmentCost;
+    property: Activatable.Property;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AttireEnchantmentTranslation>;
+};
+export type AttireEnchantmentTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    effect: Activatable.Effect;
+    /**
+     * @deprecated
+     */
+    volume: string;
+    /**
+     * @deprecated
+     */
+    aeCost?: string;
+    /**
+     * @deprecated
+     */
+    bindingCost?: string;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<AttireEnchantment>;

package/lib/types/traditionArtifacts/AttireEnchantment.js

@@ -0,0 +1,12 @@
+/**
+ * @main AttireEnchantment
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "AttireEnchantment",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("AttireEnchantment"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};