optolith-database-schema 0.11.2 → 0.11.4

package/lib/types/_ActivatableSkillCost.d.ts

@@ -1,255 +0,0 @@
-import { DurationUnitValue } from "./_ActivatableSkillDuration.js";
-import { LocaleMap } from "./_LocaleMap.js";
-import { NonEmptyString } from "./_NonEmptyString.js";
-import { ResponsiveText, ResponsiveTextOptional, ResponsiveTextReplace } from "./_ResponsiveText.js";
-export type OneTimeCost = {
-    tag: "Single";
-    single: SingleOneTimeCost;
-} | {
-    tag: "Conjunction";
-    conjunction: MultipleOneTimeCosts;
-} | {
-    tag: "Disjunction";
-    disjunction: MultipleOneTimeCosts;
-} | {
-    tag: "Map";
-    map: CostMap;
-};
-export type SingleOneTimeCost = {
-    tag: "Modifiable";
-    modifiable: ModifiableOneTimeCost;
-} | {
-    tag: "NonModifiable";
-    non_modifiable: NonModifiableOneTimeCost;
-} | {
-    tag: "Indefinite";
-    indefinite: IndefiniteOneTimeCost;
-};
-/**
- * @minItems 2
- */
-export type MultipleOneTimeCosts = SingleOneTimeCost[];
-export type ModifiableOneTimeCost = {
-    /**
-     * The initial skill modification identifier/level.
-     * @integer
-     * @minimum 1
-     * @maximum 6
-     */
-    initial_modification_level: number;
-    /**
-     * The part of the cost value that has to be spent permanently.
-     * @integer
-     * @minimum 1
-     */
-    permanent_value?: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations?: LocaleMap<ModifiableOneTimeCostTranslation>;
-};
-export type ModifiableOneTimeCostTranslation = {
-    /**
-     * A replacement string.
-     */
-    replacement: ResponsiveTextReplace;
-};
-export type NonModifiableOneTimeCost = {
-    /**
-     * If `true`, the non-modifiable value is a minimum value.
-     */
-    is_minimum?: boolean;
-    /**
-     * The AE cost value.
-     * @integer
-     * @minimum 1
-     */
-    value: number;
-    /**
-     * The part of the cost value that has to be spent permanently.
-     * @integer
-     * @minimum 1
-     */
-    permanent_value?: number;
-    /**
-     * The cost have to be per a specific countable entity, e.g. `8 KP per
-     * person`.
-     */
-    per?: NonModifiableOneTimeCostPerCountable;
-    /**
-     * All translations for the entry, identified by IETF language tag
-     * (BCP47).
-     */
-    translations?: LocaleMap<NonModifiableOneTimeCostTranslation>;
-};
-export type NonModifiableOneTimeCostPerCountable = {
-    /**
-     * If defined, the minimum total AE that have to be spent casting the
-     * skill.
-     */
-    minimum_total?: number;
-    /**
-     * All translations for the entry, identified by IETF language tag
-     * (BCP47).
-     */
-    translations: LocaleMap<NonModifiableOneTimeCostPerCountableTranslation>;
-};
-export type NonModifiableOneTimeCostPerCountableTranslation = {
-    /**
-     * The countable entity name.
-     */
-    countable: ResponsiveText;
-};
-export type NonModifiableOneTimeCostTranslation = {
-    /**
-     * A note, appended to the generated string in parenthesis.
-     */
-    note: ResponsiveTextOptional;
-};
-export type IndefiniteOneTimeCost = {
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<IndefiniteOneTimeCostTranslation>;
-};
-export type IndefiniteOneTimeCostTranslation = {
-    /**
-     * A description of where the cost come from.
-     */
-    description: ResponsiveText;
-};
-/**
- * A content that is `2/4/8/16 AE for an item the size of a
- * cup/chest/door/castle gate` may be respresented as the following map:
- *
- * ```yaml
- * options:
- *   - value: 2
- *     label: "cup"
- *   - value: 4
- *     label: "chest"
- *   - value: 8
- *     label: "door"
- *   - value: 16
- *     label: "castle gate"
- * for_append: "an item the size of a"
- * ```
- *
- * This will generate the exact same string as seen above – given it is set
- * for a spellwork and thus `AE` is used.
- */
-export type CostMap = {
-    /**
-     * The possible costs and associated labels.
-     * @minItems 2
-     */
-    options: CostMapOption[];
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations?: LocaleMap<CostMapTranslation>;
-};
-export type CostMapOption = {
-    /**
-     * The full cost value for this option.
-     * @integer
-     * @minimum 1
-     */
-    value: number;
-    /**
-     * The part of the `value` that has to be paid permanently.
-     * @integer
-     * @minimum 0
-     */
-    permanent_value?: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations?: LocaleMap<CostMapOptionTranslation>;
-};
-export type CostMapOptionTranslation = {
-    /**
-     * The description of the option for cost string generation.
-     */
-    label: NonEmptyString;
-    /**
-     * The description of the option if used standalone. Only used if
-     * different from `label`.
-     */
-    label_standalone?: NonEmptyString;
-};
-export type CostMapTranslation = {
-    /**
-     * Place a string between the `for` and the grouped map option labels.
-     */
-    list_prepend?: NonEmptyString;
-    /**
-     * Place a string after the grouped map option labels.
-     */
-    list_append?: NonEmptyString;
-    /**
-     * If the string from the book cannot be generated using the default
-     * generation technique, use this string. All options still need to be
-     * inserted propertly, since it may be used by in-game tools to provide a
-     * selection to players.
-     */
-    replacement?: NonEmptyString;
-};
-export type SustainedCost = {
-    tag: "Modifiable";
-    modifiable: ModifiableSustainedCost;
-} | {
-    tag: "NonModifiable";
-    non_modifiable: NonModifiableSustainedCost;
-};
-export type ModifiableSustainedCost = {
-    /**
-     * The initial skill modification identifier/level.
-     * @integer
-     * @minimum 1
-     * @maximum 6
-     */
-    initial_modification_level: number;
-    /**
-     * The sustain interval.
-     */
-    interval: DurationUnitValue;
-};
-export type NonModifiableSustainedCost = {
-    /**
-     * If `true`, the non-modifiable value is a minimum value.
-     */
-    is_minimum?: boolean;
-    /**
-     * The AE cost value.
-     * @integer
-     * @minimum 1
-     */
-    value: number;
-    /**
-     * The cost have to be per a specific countable entity, e.g. `8 KP per
-     * person per 5 minutes`.
-     */
-    per?: NonModifiableSustainedCostPerCountable;
-    /**
-     * The sustain interval.
-     */
-    interval: DurationUnitValue;
-};
-export type NonModifiableSustainedCostPerCountable = {
-    /**
-     * If defined, the minimum total AE that have to be spent casting the
-     * skill.
-     */
-    minimum_total?: number;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<NonModifiableSustainedCostPerCountableTranslation>;
-};
-export type NonModifiableSustainedCostPerCountableTranslation = {
-    /**
-     * The countable entity name.
-     */
-    countable: ResponsiveText;
-};

package/lib/types/_ActivatableSkillCost.js

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

package/lib/types/_ActivatableSkillDuration.d.ts

@@ -1,138 +0,0 @@
-import { CheckResultBased } from "./_ActivatableSkillCheckResultBased.js";
-import { LocaleMap } from "./_LocaleMap.js";
-import { ResponsiveText, ResponsiveTextReplace } from "./_ResponsiveText.js";
-export type DurationForOneTime = {
-    tag: "Immediate";
-    immediate: Immediate;
-} | {
-    tag: "Permanent";
-    permanent: PermanentDuration;
-} | {
-    tag: "Fixed";
-    fixed: FixedDuration;
-} | {
-    tag: "CheckResultBased";
-    check_result_based: CheckResultBasedDuration;
-} | {
-    tag: "Indefinite";
-    indefinite: IndefiniteDuration;
-};
-export type Immediate = {
-    /**
-     * Specified if the duration has a maximum time span.
-     */
-    maximum?: DurationUnitValue;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations?: LocaleMap<ImmediateTranslation>;
-};
-export type ImmediateTranslation = {
-    /**
-     * A replacement string.
-     */
-    replacement: ResponsiveTextReplace;
-};
-export type PermanentDuration = {
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations?: LocaleMap<PermanentDurationTranslation>;
-};
-export type PermanentDurationTranslation = {
-    /**
-     * A replacement string.
-     */
-    replacement: ResponsiveTextReplace;
-};
-export type FixedDuration = {
-    /**
-     * If the duration is the maximum duration, so it may end earlier.
-     */
-    is_maximum?: true;
-    /**
-     * The (unitless) duration.
-     * @integer
-     * @minimum 1
-     */
-    value: number;
-    /**
-     * The duration unit.
-     */
-    unit: DurationUnit;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations?: LocaleMap<FixedDurationTranslation>;
-};
-export type FixedDurationTranslation = {
-    /**
-     * A replacement string.
-     */
-    replacement: ResponsiveTextReplace;
-};
-/**
- * Defines the duration being based on a check result.
- */
-export type CheckResultBasedDuration = CheckResultBased & {
-    /**
-     * If the duration is the maximum duration, so it may end earlier.
-     */
-    is_maximum?: true;
-    /**
-     * The duration unit.
-     */
-    unit: DurationUnit;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations?: LocaleMap<CheckResultBasedDurationTranslation>;
-};
-export type CheckResultBasedDurationTranslation = {
-    /**
-     * A replacement string.
-     */
-    replacement: ResponsiveTextReplace;
-};
-export type IndefiniteDuration = {
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<IndefiniteDurationTranslation>;
-};
-export type IndefiniteDurationTranslation = {
-    /**
-     * A description of the duration.
-     */
-    description: ResponsiveText;
-};
-export type DurationForSustained = {
-    /**
-     * The sustained skill can be active a maximum amount of time.
-     */
-    maximum: DurationUnitValue;
-};
-export declare enum DurationUnit {
-    Seconds = "Seconds",
-    Minutes = "Minutes",
-    Hours = "Hours",
-    Days = "Days",
-    Weeks = "Weeks",
-    Months = "Months",
-    Years = "Years",
-    Centuries = "Centuries",
-    Actions = "Actions",
-    CombatRounds = "CombatRounds"
-}
-export type DurationUnitValue = {
-    /**
-     * The (unitless) duration value.
-     * @integer
-     * @minimum 1
-     */
-    value: number;
-    /**
-     * The unit of the `value`.
-     */
-    unit: DurationUnit;
-};

package/lib/types/_ActivatableSkillDuration.js

@@ -1,13 +0,0 @@
-export var DurationUnit;
-(function (DurationUnit) {
-    DurationUnit["Seconds"] = "Seconds";
-    DurationUnit["Minutes"] = "Minutes";
-    DurationUnit["Hours"] = "Hours";
-    DurationUnit["Days"] = "Days";
-    DurationUnit["Weeks"] = "Weeks";
-    DurationUnit["Months"] = "Months";
-    DurationUnit["Years"] = "Years";
-    DurationUnit["Centuries"] = "Centuries";
-    DurationUnit["Actions"] = "Actions";
-    DurationUnit["CombatRounds"] = "CombatRounds";
-})(DurationUnit = DurationUnit || (DurationUnit = {}));

package/lib/types/_ActivatableSkillEffect.d.ts

@@ -1,68 +0,0 @@
-import { NonEmptyMarkdown } from "./_NonEmptyString.js";
-/**
- * The effect description may be either a plain text or a text that is divided
- * by a list of effects for each quality level. It may also be a list for each
- * two quality levels.
- */
-export type Effect = {
-    tag: "Plain";
-    plain: PlainEffect;
-} | {
-    tag: "ForEachQualityLevel";
-    for_each_quality_level: EffectForEachQualityLevel;
-} | {
-    tag: "ForEachTwoQualityLevels";
-    for_each_two_quality_levels: EffectForEachTwoQualityLevels;
-};
-export type PlainEffect = {
-    /**
-     * The effect description.
-     */
-    text: NonEmptyMarkdown;
-};
-export type EffectForEachQualityLevel = {
-    /**
-     * The effect description before the list of effects for each quality
-     * level.
-     */
-    text_before: NonEmptyMarkdown;
-    /**
-     * The list of effects for each quality level. The first element
-     * represents QL 1, the second element QL 2, and so on.
-     */
-    quality_levels: [
-        NonEmptyMarkdown,
-        NonEmptyMarkdown,
-        NonEmptyMarkdown,
-        NonEmptyMarkdown,
-        NonEmptyMarkdown,
-        NonEmptyMarkdown
-    ];
-    /**
-     * The effect description after the list of effects for each quality
-     * level.
-     */
-    text_after?: NonEmptyMarkdown;
-};
-export type EffectForEachTwoQualityLevels = {
-    /**
-     * The effect description before the list of effects for each quality
-     * level.
-     */
-    text_before: NonEmptyMarkdown;
-    /**
-     * The list of effects for each two quality levels. The first element
-     * represents QL 1–2, the second element QL 3–4 and the third element QL
-     * 5–6.
-     */
-    quality_levels: [
-        NonEmptyMarkdown,
-        NonEmptyMarkdown,
-        NonEmptyMarkdown
-    ];
-    /**
-     * The effect description after the list of effects for each quality
-     * level.
-     */
-    text_after?: NonEmptyMarkdown;
-};

package/lib/types/_ActivatableSkillEffect.js

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

package/lib/types/_ActivatableSkillRange.d.ts

@@ -1,110 +0,0 @@
-import { CheckResultBased } from "./_ActivatableSkillCheckResultBased.js";
-import { LocaleMap } from "./_LocaleMap.js";
-import { ResponsiveTextOptional, ResponsiveTextReplace } from "./_ResponsiveText.js";
-export type Range = {
-    value: RangeValue;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations?: LocaleMap<RangeTranslation>;
-};
-export type RangeValue = {
-    tag: "Modifiable";
-    modifiable: ModifiableRange;
-} | {
-    tag: "Sight";
-    sight: {};
-} | {
-    tag: "Self";
-    self: {};
-}
-/**
- * German: *dereumfassend*
- */
- | {
-    tag: "Global";
-    global: {};
-} | {
-    tag: "Touch";
-    touch: {};
-} | {
-    tag: "Fixed";
-    fixed: FixedRange;
-} | {
-    tag: "CheckResultBased";
-    check_result_based: CheckResultBasedRange;
-};
-export type ModifiableRange = {
-    /**
-     * If `true`, the range is a maximum range.
-     */
-    is_maximum?: true;
-    /**
-     * The initial skill modification identifier/level.
-     * @integer
-     * @minimum 1
-     * @maximum 6
-     */
-    initial_modification_level: number;
-    /**
-     * If `true`, the range is a radius.
-     */
-    is_radius?: true;
-};
-export type FixedRange = {
-    /**
-     * If `true`, the range is a maximum range.
-     */
-    is_maximum?: true;
-    /**
-     * The (unitless) range value.
-     * @integer
-     * @minimum 1
-     */
-    value: number;
-    /**
-     * The unit of the `value`.
-     */
-    unit: RangeUnit;
-    /**
-     * If `true`, the range is a radius.
-     */
-    is_radius?: true;
-};
-/**
- * Defines the range being based on a check result.
- */
-export type CheckResultBasedRange = CheckResultBased & {
-    /**
-     * If the range is the maximum range.
-     */
-    is_maximum?: true;
-    /**
-     * The duration unit.
-     */
-    unit: RangeUnit;
-    /**
-     * If `true`, the range is a radius.
-     */
-    is_radius?: true;
-};
-/**
- * @minProperties 1
- */
-export type RangeTranslation = {
-    /**
-     * A note, appended to the generated string in parenthesis. If the
-     * generated is modified using `replacement`, the note is appended to
-     * the modifier string.
-     */
-    note?: ResponsiveTextOptional;
-    /**
-     * A replacement string. If `note` is provided, it is appended to the
-     * replaced string.
-     */
-    replacement?: ResponsiveTextReplace;
-};
-export declare enum RangeUnit {
-    Steps = "Steps",
-    Miles = "Miles"
-}

package/lib/types/_ActivatableSkillRange.js

@@ -1,5 +0,0 @@
-export var RangeUnit;
-(function (RangeUnit) {
-    RangeUnit["Steps"] = "Steps";
-    RangeUnit["Miles"] = "Miles";
-})(RangeUnit = RangeUnit || (RangeUnit = {}));

package/lib/types/_ActivatableSkillTargetCategory.d.ts

@@ -1,39 +0,0 @@
-import { LocaleMap } from "./_LocaleMap.js";
-import { NonEmptyString } from "./_NonEmptyString.js";
-import { TargetCategoryReference } from "./_SimpleReferences.js";
-/**
- * The target category – the kind of creature or object – the skill affects.
- *
- * If no target categories are given, the skill applies to all target
- * categories.
- */
-export type TargetCategory = SpecificTargetCategory[];
-export type SpecificTargetCategory = {
-    id: TargetCategoryIdentifier;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations?: LocaleMap<SpecificTargetCategoryTranslation>;
-};
-export type SpecificTargetCategoryTranslation = {
-    /**
-     * A note, appended to the generated string in parenthesis.
-     */
-    note: NonEmptyString;
-};
-export type TargetCategoryIdentifier = {
-    tag: "Self";
-    self: {};
-} | {
-    tag: "Zone";
-    zone: {};
-} | {
-    tag: "LiturgicalChantsAndCeremonies";
-    liturgical_chants_and_ceremonies: {};
-} | {
-    tag: "Cantrips";
-    cantrips: {};
-} | {
-    tag: "Predefined";
-    predefined: TargetCategoryReference;
-};

package/lib/types/_ActivatableSkillTargetCategory.js

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

package/lib/types/_AlternativeNames.d.ts

@@ -1,11 +0,0 @@
-import { NonEmptyString } from "./_NonEmptyString.js";
-export type AlternativeName = {
-    /**
-     * An alternative name of the disease.
-     */
-    name: NonEmptyString;
-    /**
-     * The region where this alternative name is used.
-     */
-    region?: NonEmptyString;
-};

package/lib/types/_AlternativeNames.js

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

package/lib/types/_ArcaneTradition.d.ts

@@ -1,28 +0,0 @@
-/**
- * @main ArcaneTradition
- */
-import { LocaleMap } from "./_LocaleMap.js";
-import { NonEmptyString } from "./_NonEmptyString.js";
-import { ArcaneTraditionPrerequisites } from "./_Prerequisite.js";
-/**
- * @title Arcane Tradition
- */
-export type ArcaneTradition = {
-    /**
-     * The arcane tradition's identifier. An unique, increasing integer.
-     * @integer
-     * @minimum 1
-     */
-    id: number;
-    prerequisites: ArcaneTraditionPrerequisites;
-    /**
-     * All translations for the entry, identified by IETF language tag (BCP47).
-     */
-    translations: LocaleMap<ArcaneTraditionTranslation>;
-};
-export type ArcaneTraditionTranslation = {
-    /**
-     * The arcane tradition's name.
-     */
-    name: NonEmptyString;
-};

package/lib/types/_ArcaneTradition.js

@@ -1,4 +0,0 @@
-/**
- * @main ArcaneTradition
- */
-export {};