optolith-database-schema 0.0.1

package/lib/types/magicalActions/MagicalRune.d.ts

@@ -0,0 +1,241 @@
+/**
+ * @main MagicalRune
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { Duration, Effect } from "../_ActivatableSkill";
+import { ImprovementCost } from "../_ImprovementCost";
+import { SkillCheck } from "../_SkillCheck";
+/**
+ * @title Magical Rune
+ */
+export declare type MagicalRune = {
+    /**
+     * The magical rune's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * In some cases, the target's Spirit or Toughness is applied as a penalty.
+     */
+    check_penalty?: {
+        tag: "CloseCombatTechnique";
+        /**
+         * A map from close combat techniques to their modifiers.
+         * @minItems 1
+         */
+        map: {
+            /**
+             * The close combat technique's identifier.
+             * @integer
+             * @minimum 1
+             */
+            combat_technique_id: number;
+            /**
+             * The check modifier for the specified close combat technique.
+             * @integer
+             */
+            modifier: number;
+        }[];
+        other: {
+            /**
+             * The check modifier for close combat techniques not specified in
+             * `map`.
+             * @integer
+             */
+            modifier: number;
+        };
+    };
+    /**
+     * Measurable parameters of a magical rune.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the magical rune.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The native name of the magical rune.
+             * @minLength 1
+             */
+            native_name: string;
+            /**
+             * 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.
+             */
+            effect: Effect.T;
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            crafting_time: {
+                slow: {
+                    full: string;
+                    abbr: string;
+                };
+                fast: {
+                    full: string;
+                    abbr: string;
+                };
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                slow: {
+                    full: string;
+                    abbr: string;
+                };
+                fast: {
+                    full: string;
+                    abbr: string;
+                };
+            };
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a magical rune.
+ */
+declare type PerformanceParameters = {
+    /**
+     * The AE cost.
+     */
+    cost: {
+        tag: "Single";
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * All translations for the entry, identified by IETF language tag
+         * (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * @minProperties 1
+             */
+            [localeId: string]: {
+                /**
+                 * A note, appended to the generated string in parenthesis.
+                 */
+                note?: {
+                    /**
+                     * The full note.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed note, if applicable. If not specified it should not
+                     * be displayed in small location.
+                     * @minLength 1
+                     */
+                    compressed?: string;
+                };
+            };
+        };
+    } | {
+        tag: "Disjunction";
+        /**
+         * A set of possible AE cost values.
+         * @minItems 2
+         */
+        list: {
+            /**
+              * The AE cost value.
+              * @integer
+              * @minimum 1
+              */
+            value: number;
+        }[];
+    };
+    /**
+     * The crafting time.
+     */
+    crafting_time: {
+        /**
+         * The (unitless) crafting time.
+         */
+        value: 1 | 2 | 4;
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations?: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             * @minProperties 1
+             */
+            [localeId: string]: {
+                /**
+                 * The crafting time has to be per a specific countable entity, e.g. `8
+                 * action per person`.
+                 */
+                per?: {
+                    /**
+                     * The full countable entity name.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * The compressed countable entity name.
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+    /**
+     * The duration.
+     */
+    duration: {
+        /**
+         * The duration on slow rune application.
+         */
+        slow: Duration.CheckResultBased;
+        /**
+         * The duration on fast rune application.
+         */
+        fast: Duration.CheckResultBased;
+    };
+};
+export {};

package/lib/types/magicalActions/MagicalRune.js

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

package/lib/types/magicalActions/ZibiljaRitual.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @main ZibiljaRitual
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+import { Effect, PerformanceParameters, TargetCategory } from "../_ActivatableSkill";
+import { ImprovementCost } from "../_ImprovementCost";
+import { SkillCheck, SkillCheckPenalty } from "../_SkillCheck";
+/**
+ * @title Zibilja Ritual
+ */
+export declare type ZibiljaRitual = {
+    /**
+     * The zibilja ritual's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * In some cases, the target's Spirit or Toughness is applied as a penalty.
+     */
+    check_penalty?: SkillCheckPenalty;
+    /**
+     * Measurable parameters of a zibilja ritual.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory.T;
+    /**
+     * The property's identifier.
+     * @integer
+     * @minimum 1
+     */
+    property_id: number;
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the zibilja ritual.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * 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.
+             */
+            effect: Effect.T;
+            /**
+             * @deprecated
+             */
+            casting_time: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            range: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            target: string;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/magicalActions/ZibiljaRitual.js

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

package/lib/types/magicalActions/_MusicTradition.d.ts

@@ -0,0 +1,28 @@
+/**
+ * A reference to a music tradition with the music-tradition-specific name of
+ * the entry
+ */
+export declare type MusicTraditionReference = {
+    /**
+     * The music tradition's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The music-tradition-specific name of the entry.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/magicalActions/_MusicTradition.js

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

package/lib/types/magicalActions/_SkillReference.d.ts

@@ -0,0 +1,13 @@
+/**
+ * A reference to a skill used for performing melodies.
+ */
+export declare type SkillReference = {
+    /**
+     * The skill's identifier.
+     */
+    id: SkillIdentifier;
+};
+export declare enum SkillIdentifier {
+    Singing = 9,
+    Music = 56
+}

package/lib/types/magicalActions/_SkillReference.js

@@ -0,0 +1,5 @@
+export var SkillIdentifier;
+(function (SkillIdentifier) {
+    SkillIdentifier[SkillIdentifier["Singing"] = 9] = "Singing";
+    SkillIdentifier[SkillIdentifier["Music"] = 56] = "Music";
+})(SkillIdentifier || (SkillIdentifier = {}));

package/lib/types/rule/FocusRule.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @main FocusRule
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+/**
+ * @title Focus Rule
+ */
+export declare type FocusRule = {
+    /**
+     * The focus rule's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The focus rule's subject's identifier.
+     * @integer
+     * @minimum 1
+     */
+    subject_id: number;
+    /**
+     * The focus rule's level.
+     * @integer
+     * @minimum 1
+     * @maximum 4
+     */
+    level: number;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the focus rule.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The description of the focus rule.
+             * @markdown
+             * @minLength 1
+             */
+            description: string;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/rule/FocusRule.js

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

package/lib/types/rule/FocusRule_Subject.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @main Subject
+ */
+/**
+ * Subjects or Subject Areas are the categories of Focus Rules.
+ * @title Subject
+ */
+export declare type Subject = {
+    /**
+     * The subject's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The subject.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/rule/FocusRule_Subject.js

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

package/lib/types/rule/OptionalRule.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @main OptionalRule
+ */
+import { Errata } from "../source/_Erratum";
+import { PublicationRefs } from "../source/_PublicationRef";
+/**
+ * @title Optional Rule
+ */
+export declare type OptionalRule = {
+    /**
+     * The optional rule's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The relevance of the optional rule for Optolith. It may be that it
+     * influences character creating but it may also just influnce the character
+     * sheet. If it is linked to systems in Optolith, it may be specified if this
+     * rule has not been implemented in Optolith yet.
+     */
+    relevance: Relevance;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The name of the optional rule.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The description of the optional rule.
+             * @markdown
+             * @minLength 1
+             */
+            description: string;
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * The relevance of the optional rule for Optolith. It may be that it influences
+ * character creating but it may also just influnce the character sheet. If it
+ * is linked to systems in Optolith, it may be specified if this rule has not
+ * been implemented in Optolith yet.
+ */
+declare type Relevance = {
+    tag: "Extraneous";
+} | {
+    tag: "Linked";
+    /**
+     * Does the optional rule have an impact on character creation or character
+     * sheet and this effect has not been implemented in Optolith yet? If
+     * `true`, the optional rule cannot be activated.
+     */
+    isMissingImplementation?: boolean;
+};
+export {};

package/lib/types/rule/OptionalRule.js

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

package/lib/types/source/Publication.d.ts

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

package/lib/types/source/Publication.js

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

package/lib/types/source/_Erratum.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @main Errata
+ */
+/**
+ * A list of errata for the entry in the specific language.
+ * @title Errata
+ * @minItems 1
+ */
+export declare type Errata = Erratum[];
+/**
+ * @title Erratum
+ */
+export declare type Erratum = {
+    /**
+     * The date when the change was confirmed and applied to the entry.
+     * @format date
+     */
+    date: string;
+    /**
+     * A description of what changed.
+     * @markdown
+     * @minLength 1
+     */
+    description: string;
+};

package/lib/types/source/_Erratum.js

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