optolith-database-schema 0.17.0 → 0.18.1

package/lib/types/_ActivatableSkillCost.d.ts

@@ -1,255 +1,209 @@
-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;
-};
+import { Array, Boolean, Enum, EnumCase, IncludeIdentifier, Integer, Object, String, TypeAlias } from "tsondb/schema/def";
+export declare const OneTimeCost: Enum<"OneTimeCost", {
+    Single: EnumCase<IncludeIdentifier<[], Enum<"SingleOneTimeCost", {
+        Modifiable: EnumCase<IncludeIdentifier<[], TypeAlias<"ModifiableOneTimeCost", Object<{
+            initial_modification_level: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;
+            permanent_value: import("tsondb/schema/def").MemberDecl<Integer, false>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"ModifiableOneTimeCostTranslation", {
+                replacement: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveTextReplace", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                }>, []>>, true>;
+            }>, false>;
+        }>, []>>>;
+        NonModifiable: EnumCase<IncludeIdentifier<[], TypeAlias<"NonModifiableOneTimeCost", Object<{
+            is_minimum: import("tsondb/schema/def").MemberDecl<Boolean, false>;
+            value: import("tsondb/schema/def").MemberDecl<Integer, true>;
+            permanent_value: import("tsondb/schema/def").MemberDecl<Integer, false>;
+            per: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"NonModifiableOneTimeCostPerCountable", Object<{
+                minimum_total: import("tsondb/schema/def").MemberDecl<Integer, false>;
+                translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"NonModifiableOneTimeCostPerCountableTranslation", {
+                    countable: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveText", Object<{
+                        full: import("tsondb/schema/def").MemberDecl<String, true>;
+                        compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                    }>, []>>, true>;
+                }>, false>;
+            }>, []>>, false>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"NonModifiableOneTimeCostTranslation", {
+                note: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveTextOptional", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, false>;
+                }>, []>>, true>;
+            }>, false>;
+        }>, []>>>;
+        Indefinite: EnumCase<IncludeIdentifier<[], TypeAlias<"IndefiniteOneTimeCost", Object<{
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"IndefiniteOneTimeCostTranslation", {
+                description: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveText", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                }>, []>>, true>;
+            }>, true>;
+        }>, []>>>;
+    }, []>>>;
+    Conjunction: EnumCase<IncludeIdentifier<[], TypeAlias<"MultipleOneTimeCosts", Array<IncludeIdentifier<[], Enum<"SingleOneTimeCost", {
+        Modifiable: EnumCase<IncludeIdentifier<[], TypeAlias<"ModifiableOneTimeCost", Object<{
+            initial_modification_level: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;
+            permanent_value: import("tsondb/schema/def").MemberDecl<Integer, false>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"ModifiableOneTimeCostTranslation", {
+                replacement: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveTextReplace", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                }>, []>>, true>;
+            }>, false>;
+        }>, []>>>;
+        NonModifiable: EnumCase<IncludeIdentifier<[], TypeAlias<"NonModifiableOneTimeCost", Object<{
+            is_minimum: import("tsondb/schema/def").MemberDecl<Boolean, false>;
+            value: import("tsondb/schema/def").MemberDecl<Integer, true>;
+            permanent_value: import("tsondb/schema/def").MemberDecl<Integer, false>;
+            per: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"NonModifiableOneTimeCostPerCountable", Object<{
+                minimum_total: import("tsondb/schema/def").MemberDecl<Integer, false>;
+                translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"NonModifiableOneTimeCostPerCountableTranslation", {
+                    countable: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveText", Object<{
+                        full: import("tsondb/schema/def").MemberDecl<String, true>;
+                        compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                    }>, []>>, true>;
+                }>, false>;
+            }>, []>>, false>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"NonModifiableOneTimeCostTranslation", {
+                note: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveTextOptional", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, false>;
+                }>, []>>, true>;
+            }>, false>;
+        }>, []>>>;
+        Indefinite: EnumCase<IncludeIdentifier<[], TypeAlias<"IndefiniteOneTimeCost", Object<{
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"IndefiniteOneTimeCostTranslation", {
+                description: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveText", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                }>, []>>, true>;
+            }>, true>;
+        }>, []>>>;
+    }, []>>>, []>>>;
+    Disjunction: EnumCase<IncludeIdentifier<[], TypeAlias<"MultipleOneTimeCosts", Array<IncludeIdentifier<[], Enum<"SingleOneTimeCost", {
+        Modifiable: EnumCase<IncludeIdentifier<[], TypeAlias<"ModifiableOneTimeCost", Object<{
+            initial_modification_level: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;
+            permanent_value: import("tsondb/schema/def").MemberDecl<Integer, false>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"ModifiableOneTimeCostTranslation", {
+                replacement: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveTextReplace", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                }>, []>>, true>;
+            }>, false>;
+        }>, []>>>;
+        NonModifiable: EnumCase<IncludeIdentifier<[], TypeAlias<"NonModifiableOneTimeCost", Object<{
+            is_minimum: import("tsondb/schema/def").MemberDecl<Boolean, false>;
+            value: import("tsondb/schema/def").MemberDecl<Integer, true>;
+            permanent_value: import("tsondb/schema/def").MemberDecl<Integer, false>;
+            per: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"NonModifiableOneTimeCostPerCountable", Object<{
+                minimum_total: import("tsondb/schema/def").MemberDecl<Integer, false>;
+                translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"NonModifiableOneTimeCostPerCountableTranslation", {
+                    countable: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveText", Object<{
+                        full: import("tsondb/schema/def").MemberDecl<String, true>;
+                        compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                    }>, []>>, true>;
+                }>, false>;
+            }>, []>>, false>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"NonModifiableOneTimeCostTranslation", {
+                note: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveTextOptional", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, false>;
+                }>, []>>, true>;
+            }>, false>;
+        }>, []>>>;
+        Indefinite: EnumCase<IncludeIdentifier<[], TypeAlias<"IndefiniteOneTimeCost", Object<{
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"IndefiniteOneTimeCostTranslation", {
+                description: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveText", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                }>, []>>, true>;
+            }>, true>;
+        }>, []>>>;
+    }, []>>>, []>>>;
+    Map: EnumCase<IncludeIdentifier<[], TypeAlias<"CostMap", Object<{
+        options: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], TypeAlias<"CostMapOption", Object<{
+            value: import("tsondb/schema/def").MemberDecl<Integer, true>;
+            permanent_value: import("tsondb/schema/def").MemberDecl<Integer, false>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"CostMapOptionTranslation", {
+                label: import("tsondb/schema/def").MemberDecl<String, true>;
+                label_standalone: import("tsondb/schema/def").MemberDecl<String, false>;
+            }>, false>;
+        }>, []>>>, true>;
+        translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"CostMapTranslation", {
+            list_prepend: import("tsondb/schema/def").MemberDecl<String, false>;
+            list_append: import("tsondb/schema/def").MemberDecl<String, false>;
+            replacement: import("tsondb/schema/def").MemberDecl<String, false>;
+        }>, false>;
+    }>, []>>>;
+}, []>;
+export declare const IndefiniteOneTimeCost: TypeAlias<"IndefiniteOneTimeCost", Object<{
+    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"IndefiniteOneTimeCostTranslation", {
+        description: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveText", Object<{
+            full: import("tsondb/schema/def").MemberDecl<String, true>;
+            compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+        }>, []>>, true>;
+    }>, true>;
+}>, []>;
+export declare const CostMap: TypeAlias<"CostMap", Object<{
+    options: import("tsondb/schema/def").MemberDecl<Array<IncludeIdentifier<[], TypeAlias<"CostMapOption", Object<{
+        value: import("tsondb/schema/def").MemberDecl<Integer, true>;
+        permanent_value: import("tsondb/schema/def").MemberDecl<Integer, false>;
+        translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"CostMapOptionTranslation", {
+            label: import("tsondb/schema/def").MemberDecl<String, true>;
+            label_standalone: import("tsondb/schema/def").MemberDecl<String, false>;
+        }>, false>;
+    }>, []>>>, true>;
+    translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"CostMapTranslation", {
+        list_prepend: import("tsondb/schema/def").MemberDecl<String, false>;
+        list_append: import("tsondb/schema/def").MemberDecl<String, false>;
+        replacement: import("tsondb/schema/def").MemberDecl<String, false>;
+    }>, false>;
+}>, []>;
+export declare const SustainedCost: Enum<"SustainedCost", {
+    Modifiable: EnumCase<IncludeIdentifier<[], TypeAlias<"ModifiableSustainedCost", Object<{
+        initial_modification_level: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").ReferenceIdentifierType, true>;
+        interval: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"DurationUnitValue", Object<{
+            value: import("tsondb/schema/def").MemberDecl<Integer, true>;
+            unit: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], Enum<"DurationUnit", {
+                Seconds: EnumCase<null>;
+                Minutes: EnumCase<null>;
+                Hours: EnumCase<null>;
+                Days: EnumCase<null>;
+                Weeks: EnumCase<null>;
+                Months: EnumCase<null>;
+                Years: EnumCase<null>;
+                Centuries: EnumCase<null>;
+                Actions: EnumCase<null>;
+                CombatRounds: EnumCase<null>;
+            }, []>>, true>;
+        }>, []>>, true>;
+    }>, []>>>;
+    NonModifiable: EnumCase<IncludeIdentifier<[], TypeAlias<"NonModifiableSustainedCost", Object<{
+        is_minimum: import("tsondb/schema/def").MemberDecl<Boolean, false>;
+        value: import("tsondb/schema/def").MemberDecl<Integer, true>;
+        per: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"NonModifiableSustainedCostPerCountable", Object<{
+            minimum_total: import("tsondb/schema/def").MemberDecl<Integer, false>;
+            translations: import("tsondb/schema/def").MemberDecl<import("tsondb/schema/def").NestedEntityMapType<"NonModifiableSustainedCostPerCountableTranslation", {
+                countable: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"ResponsiveText", Object<{
+                    full: import("tsondb/schema/def").MemberDecl<String, true>;
+                    compressed: import("tsondb/schema/def").MemberDecl<String, true>;
+                }>, []>>, true>;
+            }>, true>;
+        }>, []>>, false>;
+        interval: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], TypeAlias<"DurationUnitValue", Object<{
+            value: import("tsondb/schema/def").MemberDecl<Integer, true>;
+            unit: import("tsondb/schema/def").MemberDecl<IncludeIdentifier<[], Enum<"DurationUnit", {
+                Seconds: EnumCase<null>;
+                Minutes: EnumCase<null>;
+                Hours: EnumCase<null>;
+                Days: EnumCase<null>;
+                Weeks: EnumCase<null>;
+                Months: EnumCase<null>;
+                Years: EnumCase<null>;
+                Centuries: EnumCase<null>;
+                Actions: EnumCase<null>;
+                CombatRounds: EnumCase<null>;
+            }, []>>, true>;
+        }>, []>>, true>;
+    }>, []>>>;
+}, []>;