optolith-database-schema 0.2.4 → 0.4.1

package/lib/types/_ActivatableSkill.js

@@ -1,35 +1,4 @@
 /**
  * @title Activatable Skill
  */
-export var CastingTime;
-(function (CastingTime) {
-    let CastingTimeDuringLovemakingUnit;
-    (function (CastingTimeDuringLovemakingUnit) {
-        CastingTimeDuringLovemakingUnit["SeductionActions"] = "SeductionActions";
-        CastingTimeDuringLovemakingUnit["Rounds"] = "Rounds";
-    })(CastingTimeDuringLovemakingUnit = CastingTime.CastingTimeDuringLovemakingUnit || (CastingTime.CastingTimeDuringLovemakingUnit = {}));
-})(CastingTime || (CastingTime = {}));
-export var Range;
-(function (Range) {
-    let Unit;
-    (function (Unit) {
-        Unit["Steps"] = "Steps";
-        Unit["Miles"] = "Miles";
-    })(Unit = Range.Unit || (Range.Unit = {}));
-})(Range || (Range = {}));
-export var Duration;
-(function (Duration) {
-    let Unit;
-    (function (Unit) {
-        Unit["Seconds"] = "Seconds";
-        Unit["Minutes"] = "Minutes";
-        Unit["Hours"] = "Hours";
-        Unit["Days"] = "Days";
-        Unit["Weeks"] = "Weeks";
-        Unit["Months"] = "Months";
-        Unit["Years"] = "Years";
-        Unit["Centuries"] = "Centuries";
-        Unit["Actions"] = "Actions";
-        Unit["CombatRounds"] = "CombatRounds";
-    })(Unit = Duration.Unit || (Duration.Unit = {}));
-})(Duration || (Duration = {}));
+export {};

package/lib/types/_ActivatableSkillCastingTime.d.ts

@@ -0,0 +1,69 @@
+import { SlowSkillCastingTimeUnit } from "./SkillModificationLevel.js";
+export declare type CastingTime<NonModifiable extends Object> = {
+    tag: "Modifiable";
+    modifiable: ModifiableCastingTime;
+} | {
+    tag: "NonModifiable";
+    non_modifiable: NonModifiable;
+};
+export declare type ModifiableCastingTime = {
+    /**
+     * The initial skill modification identifier/level.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    initial_modification_level: number;
+};
+export declare type CastingTimeIncludingLovemaking<NonModifiable extends Object> = {
+    /**
+     * The default casting time definition.
+     */
+    default: CastingTime<NonModifiable>;
+    /**
+     * The casting time during lovemaking. In Aventurian Intimacy, you may only
+     * use an activatable skill during lovemaking if it has a casting time used
+     * during lovemaking.
+     */
+    during_lovemaking?: CastingTimeDuringLovemaking;
+};
+/**
+ * The casting time during lovemaking. In Aventurian Intimacy, you may only use
+ * an activatable skill during lovemaking if it has a casting time used during
+ * lovemaking.
+ */
+export declare type CastingTimeDuringLovemaking = {
+    /**
+     * The (unitless) casting time value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The unit of the `value`.
+     */
+    unit: CastingTimeDuringLovemakingUnit;
+};
+export declare enum CastingTimeDuringLovemakingUnit {
+    SeductionActions = "SeductionActions",
+    Rounds = "Rounds"
+}
+export declare type FastSkillNonModifiableCastingTime = {
+    /**
+     * The casting time value in actions.
+     * @integer
+     * @minimum 1
+     */
+    actions: number;
+};
+export declare type SlowSkillNonModifiableCastingTime = {
+    /**
+     * The (unitless) casting time value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    unit: SlowSkillCastingTimeUnit;
+};
+export declare type FastCastingTime = CastingTimeIncludingLovemaking<FastSkillNonModifiableCastingTime>;
+export declare type SlowCastingTime = CastingTimeIncludingLovemaking<SlowSkillNonModifiableCastingTime>;

package/lib/types/_ActivatableSkillCastingTime.js

@@ -0,0 +1,5 @@
+export var CastingTimeDuringLovemakingUnit;
+(function (CastingTimeDuringLovemakingUnit) {
+    CastingTimeDuringLovemakingUnit["SeductionActions"] = "SeductionActions";
+    CastingTimeDuringLovemakingUnit["Rounds"] = "Rounds";
+})(CastingTimeDuringLovemakingUnit || (CastingTimeDuringLovemakingUnit = {}));

package/lib/types/_ActivatableSkillCheckResultBased.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Defines the derived (unitless) value.
+ */
+export declare enum CheckResultValue {
+    QualityLevels = "QualityLevels",
+    SkillPoints = "SkillPoints"
+}
+/**
+ * Defines how the the `value` is set off against the check result.
+ */
+export declare enum CheckResultArithmetic {
+    Multiply = "Multiply",
+    Divide = "Divide"
+}
+export declare type CheckResultBasedModifier = {
+    /**
+     * The arithmetic how to apply the `value` to the `base`.
+     */
+    arithmetic: CheckResultArithmetic;
+    /**
+     * The value that is applied to the `base` using the defined `arithmetic`.
+     * @integer
+     * @minimum 2
+     */
+    value: number;
+};
+/**
+ * Defines a parameter being based on a check result.
+ */
+export declare type CheckResultBased = {
+    /**
+     * The base value that is derived from the check result.
+     */
+    base: CheckResultValue;
+    /**
+     * If defined, it modifies the base value.
+     */
+    modifier?: CheckResultBasedModifier;
+};

package/lib/types/_ActivatableSkillCheckResultBased.js

@@ -0,0 +1,16 @@
+/**
+ * Defines the derived (unitless) value.
+ */
+export var CheckResultValue;
+(function (CheckResultValue) {
+    CheckResultValue["QualityLevels"] = "QualityLevels";
+    CheckResultValue["SkillPoints"] = "SkillPoints";
+})(CheckResultValue || (CheckResultValue = {}));
+/**
+ * Defines how the the `value` is set off against the check result.
+ */
+export var CheckResultArithmetic;
+(function (CheckResultArithmetic) {
+    CheckResultArithmetic["Multiply"] = "Multiply";
+    CheckResultArithmetic["Divide"] = "Divide";
+})(CheckResultArithmetic || (CheckResultArithmetic = {}));

package/lib/types/_ActivatableSkillCost.d.ts

@@ -0,0 +1,223 @@
+import { DurationUnitValue } from "./_ActivatableSkillDuration.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
+import { ResponsiveText, ResponsiveTextOptional } from "./_ResponsiveText.js";
+export declare type OneTimeCost = {
+    tag: "Single";
+    single: SingleOneTimeCost;
+} | {
+    tag: "Conjunction";
+    conjunction: MultipleOneTimeCosts;
+} | {
+    tag: "Disjunction";
+    disjunction: MultipleOneTimeCosts;
+} | {
+    tag: "Map";
+    map: CostMap;
+};
+export declare type SingleOneTimeCost = {
+    tag: "Modifiable";
+    modifiable: ModifiableOneTimeCost;
+} | {
+    tag: "NonModifiable";
+    non_modifiable: NonModifiableOneTimeCost;
+} | {
+    tag: "Indefinite";
+    indefinite: IndefiniteOneTimeCost;
+};
+/**
+ * @minItems 2
+ */
+export declare type MultipleOneTimeCosts = SingleOneTimeCost[];
+export declare 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;
+};
+export declare 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 declare 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 declare type NonModifiableOneTimeCostPerCountableTranslation = {
+    /**
+     * The countable entity name.
+     */
+    countable: ResponsiveText;
+};
+export declare type NonModifiableOneTimeCostTranslation = {
+    /**
+     * A note, appended to the generated string in parenthesis.
+     */
+    note: ResponsiveTextOptional;
+};
+export declare type IndefiniteOneTimeCost = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteOneTimeCostTranslation>;
+};
+export declare 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 declare 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 declare 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 declare 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 declare 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 declare type SustainedCost = {
+    tag: "Modifiable";
+    modifiable: ModifiableSustainedCost;
+} | {
+    tag: "NonModifiable";
+    non_modifiable: NonModifiableSustainedCost;
+};
+export declare type ModifiableSustainedCost = {
+    /**
+     * The initial skill modification identifier/level.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     */
+    initial_modification_level: number;
+    /**
+     * The sustain interval.
+     */
+    interval: DurationUnitValue;
+};
+export declare 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 sustain interval.
+     */
+    interval: DurationUnitValue;
+};

package/lib/types/_ActivatableSkillDuration.d.ts

@@ -0,0 +1,138 @@
+import { CheckResultBased } from "./_ActivatableSkillCheckResultBased.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { ResponsiveText, ResponsiveTextReplace } from "./_ResponsiveText.js";
+export declare 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 declare 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 declare type ImmediateTranslation = {
+    /**
+     * A replacement string.
+     */
+    replacement: ResponsiveTextReplace;
+};
+export declare type PermanentDuration = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<PermanentDurationTranslation>;
+};
+export declare type PermanentDurationTranslation = {
+    /**
+     * A replacement string.
+     */
+    replacement: ResponsiveTextReplace;
+};
+export declare 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 declare type FixedDurationTranslation = {
+    /**
+     * A replacement string.
+     */
+    replacement: ResponsiveTextReplace;
+};
+/**
+ * Defines the duration being based on a check result.
+ */
+export declare 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 declare type CheckResultBasedDurationTranslation = {
+    /**
+     * A replacement string.
+     */
+    replacement: ResponsiveTextReplace;
+};
+export declare type IndefiniteDuration = {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<IndefiniteDurationTranslation>;
+};
+export declare type IndefiniteDurationTranslation = {
+    /**
+     * A description of the duration.
+     */
+    description: ResponsiveText;
+};
+export declare 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 declare type DurationUnitValue = {
+    /**
+     * The (unitless) duration value.
+     * @integer
+     * @minimum 1
+     */
+    value: number;
+    /**
+     * The unit of the `value`.
+     */
+    unit: DurationUnit;
+};

package/lib/types/_ActivatableSkillDuration.js

@@ -0,0 +1,13 @@
+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 = {}));

package/lib/types/_ActivatableSkillEffect.d.ts

@@ -0,0 +1,68 @@
+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 declare type Effect = {
+    tag: "Plain";
+    plain: PlainEffect;
+} | {
+    tag: "ForEachQualityLevel";
+    for_each_quality_level: EffectForEachQualityLevel;
+} | {
+    tag: "ForEachTwoQualityLevels";
+    for_each_two_quality_levels: EffectForEachTwoQualityLevels;
+};
+export declare type PlainEffect = {
+    /**
+     * The effect description.
+     */
+    text: NonEmptyMarkdown;
+};
+export declare 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 declare 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/{equipment/_Armor.js → _ActivatableSkillEffect.js}

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