optolith-database-schema 0.0.1

package/lib/types/SexPractice.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @main SexPractice
+ */
+import { PublicationRefs } from "./source/_PublicationRef";
+/**
+ * @title Sex Practice
+ */
+export declare type SexPractice = {
+    /**
+     * The sex practice's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: 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 sex practice's name.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The rules of the sex practice.
+             * @minLength 1
+             */
+            rules: string;
+            /**
+             * How long a round of this sex practice takes.
+             * @minLength 1
+             */
+            duration: string;
+            /**
+             * Prerequisites of participants and environment. Do not specify if the
+             * sex practice has no prerequisites.
+             * @minLength 1
+             */
+            prerequisites?: string;
+            /**
+             * Effects of a failed *Seduction* check.
+             * @minLength 1
+             */
+            failed: string;
+        };
+    };
+};

package/lib/types/SexPractice.js

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

package/lib/types/Skill.d.ts

@@ -0,0 +1,169 @@
+/**
+ * @main Skill
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { ImprovementCost } from "./_ImprovementCost";
+import { SkillCheck } from "./_SkillCheck";
+/**
+ * @title Skill
+ */
+export declare type Skill = {
+    /**
+     * The skill's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Lists the linked three attributes used to make a skill check.
+     */
+    check: SkillCheck;
+    /**
+     * Lists applications for the skill, if any. This does not necessarily include
+     * all possible applications. There may also be new applications that could be
+     * purchased via certain advantages or special abilities.
+     */
+    applications: Applications;
+    /**
+     * Indicates whether encumbrance gives a penalty for checks with the skill.
+     */
+    encumbrance: Encumbrance;
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    /**
+     * The identifier of the skill group this skill belongs to.
+     */
+    group_id: 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 skill.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * If there are options available that can not be put into a selection
+             * list (like different cults), provide the label text for the input
+             * element here. Otherwise leave empty.
+             * @minLength 1
+             */
+            applications_input_label?: string;
+            /**
+             * The text listing the certain circumstances in which the encumbrance may
+             * count. This text must be used if `encumbrance` is set to `"Maybe"`,
+             * otherwise it is ignored if defined.
+             * @minLength 1
+             */
+            encumbrance_description?: string;
+            /**
+             * Mentions any tools from the equipment list that are necessary to employ
+             * the skill.
+             * @markdown
+             * @minLength 1
+             */
+            tools?: string;
+            /**
+             * Gives examples of the effects that various QL might provide.
+             * @markdown
+             * @minLength 1
+             */
+            quality: string;
+            /**
+             * Lists examples of results for a failed check.
+             * @markdown
+             * @minLength 1
+             */
+            failed: string;
+            /**
+             * Lists examples of results for a critical success.
+             * @markdown
+             * @minLength 1
+             */
+            critical: string;
+            /**
+             * Lists examples of results for botches.
+             * @markdown
+             * @minLength 1
+             */
+            botch: string;
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * A category. All available entries from the specified category will be
+ * included as separate applications.
+ */
+declare type ApplicationCategory = {
+    tag: "BlessedTraditions";
+} | {
+    tag: "Diseases";
+} | {
+    tag: "Regions";
+};
+/**
+ * The skill's applications.
+ */
+declare type Applications = {
+    tag: "Derived";
+    /**
+     * A category. All available entries from the specified category will be
+     * included as separate applications.
+     */
+    category: ApplicationCategory;
+} | {
+    tag: "Explicit";
+    /**
+     * A list of explicit applications.
+     */
+    list: Application[];
+};
+/**
+ * An explicit skill application.
+ */
+declare type Application = {
+    /**
+     * The skill application'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 skill application's name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};
+/**
+ * Indicates whether encumbrance gives a penalty for checks with the skill.
+ */
+declare type Encumbrance = {
+    tag: "True";
+} | {
+    tag: "False";
+} | {
+    tag: "Maybe";
+};
+export {};

package/lib/types/Skill.js

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

package/lib/types/SkillGroup.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @main SkillGroup
+ */
+import { SkillCheck } from "./_SkillCheck";
+/**
+ * @title Skill Group
+ */
+export declare type SkillGroup = {
+    /**
+     * The skill group's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The skill group check's attributes.
+     */
+    check: SkillCheck;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: {
+            /**
+             * The skill group's name.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The skill group's full name.
+             * @minLength 1
+             */
+            full_name: string;
+        };
+    };
+};

package/lib/types/SkillGroup.js

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

package/lib/types/SkillModificationIncrement.d.ts

@@ -0,0 +1,82 @@
+/**
+ * @main SkillModificationIncrement
+ */
+/**
+ * @title Skill Modification Increment
+ */
+declare type SkillModificationIncrement = {
+    /**
+     * The skill modification increment's identifier. It also represents the
+     * increment level.
+     * @integer
+     * @minimum 1
+     * @maximum 6
+     *
+     */
+    id: number;
+    /**
+     * Configuration for this level for fast skills (spells, liturgical chants).
+     */
+    fast: LevelTypeConfig;
+    /**
+     * Configuration for this level for slow skills (rituals, ceremonies).
+     */
+    slow: LevelTypeConfig;
+    /**
+     * 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]: {
+            /**
+             * Configuration for this level for fast skills (spells, liturgical chants).
+             * Values set here override the default generated text.
+             * @minLength 1
+             */
+            fast?: LevelTypeConfigTranslation;
+            /**
+             * Configuration for this level for slow skills (rituals, ceremonies). Values
+             * set here override the default generated text.
+             * @minLength 1
+             */
+            slow?: LevelTypeConfigTranslation;
+        };
+    };
+};
+/**
+ * Configuration of a type for a level.
+ */
+declare type LevelTypeConfig = {
+    /**
+     * Casting time in actions.
+     * @integer
+     * @minimum 1
+     */
+    casting_time: number;
+    /**
+     * Range in meters.
+     * @integer
+     * @minimum 1
+     */
+    range: number;
+    /**
+     * Cost in AE/KP.
+     * @integer
+     * @minimum 1
+     */
+    cost: number;
+};
+/**
+ * Configuration translation of a type for a level. Values set here override the
+ * default generated text.
+ */
+declare type LevelTypeConfigTranslation = {
+    /**
+     * @minLength 1
+     */
+    range: string;
+};

package/lib/types/SkillModificationIncrement.js

@@ -0,0 +1,4 @@
+"use strict";
+/**
+ * @main SkillModificationIncrement
+ */

package/lib/types/SocialStatus.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main SocialStatus
+ */
+/**
+ * @title Social Status
+ */
+export declare type SocialStatus = {
+    /**
+     * The social status' 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 social status name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/SocialStatus.js

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

package/lib/types/State.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @main State
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+/**
+ * @title State
+ */
+export declare type State = {
+    /**
+     * The state's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: 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 state.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The description of the state.
+             * @markdown
+             * @minLength 1
+             */
+            description: string;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/State.js

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

package/lib/types/TargetCategory.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @main TargetCategory
+ */
+/**
+ * @title Target Category
+ */
+export declare type TargetCategory = {
+    /**
+     * The target category's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The identifier of a superordinate target category, if present.
+     * @integer
+     * @minimum 1
+     */
+    parent_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 target category name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/TargetCategory.js

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