optolith-database-schema 0.2.4 → 0.4.1

package/lib/types/Ritual.d.ts

@@ -3,11 +3,16 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
-import { Effect, SlowPerformanceParameters, TargetCategory } from "./_ActivatableSkill.js";
+import { SlowPerformanceParameters } from "./_ActivatableSkill.js";
+import { Effect } from "./_ActivatableSkillEffect.js";
+import { TargetCategory } from "./_ActivatableSkillTargetCategory.js";
 import { Enhancements } from "./_Enhancements.js";
 import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
 import { SpellworkPrerequisites } from "./_Prerequisite.js";
+import { PropertyReference } from "./_SimpleReferences.js";
 import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck.js";
+import { Traditions } from "./_Spellwork.js";
 /**
  * @title Ritual
  */
@@ -33,42 +38,17 @@ export declare type Ritual = {
     /**
      * The target category – the kind of creature or object – the skill affects.
      */
-    target: TargetCategory.T;
+    target: TargetCategory;
     /**
-     * The property's identifier.
-     * @integer
-     * @minimum 1
+     * The associated property.
      */
-    property_id: number;
+    property: PropertyReference;
     /**
      * The tradition(s) the ritual is available for. It may be *generally*
      * available to all traditions or it may be only familiar in specific
      * traditions.
      */
-    traditions: {
-        tag: "General";
-    } | {
-        tag: "Specific";
-        /**
-         * A list of specific traditions.
-         * @minItems 1
-         */
-        list: {
-            /**
-             * The magical tradition's identifier. If `is_placeholder` is `true`
-             * then this is the magical tradition's placeholder identifier
-             * instead.
-             * @integer
-             * @minimum 1
-             */
-            id: number;
-            /**
-             * If set to `true`, the tradition is not available as a special ability
-             * yet.
-             */
-            is_placeholder?: true;
-        }[];
-    };
+    traditions: Traditions;
     /**
      * States which column is used to improve the skill.
      */
@@ -77,59 +57,54 @@ export declare type Ritual = {
     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 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;
-        };
-    };
+     */
+    translations: LocaleMap<RitualTranslation>;
     enhancements?: Enhancements;
 };
+export declare type RitualTranslation = {
+    /**
+     * The name of the 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;
+    /**
+     * @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;
+};
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Ritual>;

package/lib/types/Service.d.ts

@@ -3,6 +3,8 @@
  */
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title Service of Summoned Creatures and Monstrosities
  */
@@ -18,34 +20,26 @@ export declare type Service = {
      * @minItems 1
      * @uniqueItems
      */
-    availability: ({
-        tag: "SummonedCreatures";
-    } | {
-        tag: "Monstrosities";
-    })[];
+    availability: ServiceAvailability[];
     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 service.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The description of the service.
-             * @markdown
-             * @minLength 1
-             */
-            description: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<ServiceTranslation>;
+};
+export declare enum ServiceAvailability {
+    SummonedCreatures = "SummonedCreatures",
+    Monstrosities = "Monstrosities"
+}
+export declare type ServiceTranslation = {
+    /**
+     * The name of the service.
+     */
+    name: NonEmptyString;
+    /**
+     * The description of the service.
+     */
+    description: NonEmptyMarkdown;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Service>;

package/lib/types/Service.js

@@ -2,4 +2,9 @@
  * @main Service
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+export var ServiceAvailability;
+(function (ServiceAvailability) {
+    ServiceAvailability["SummonedCreatures"] = "SummonedCreatures";
+    ServiceAvailability["Monstrosities"] = "Monstrosities";
+})(ServiceAvailability || (ServiceAvailability = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/SexPractice.d.ts

@@ -2,6 +2,8 @@
  * @main SexPractice
  */
 import { PublicationRefs } from "./source/_PublicationRef.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 /**
  * @title Sex Practice
  */
@@ -15,40 +17,30 @@ export declare type SexPractice = {
     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;
-        };
-    };
+    translations: LocaleMap<SexPracticeTranslation>;
+};
+export declare type SexPracticeTranslation = {
+    /**
+     * The sex practice's name.
+     */
+    name: NonEmptyString;
+    /**
+     * The rules of the sex practice.
+     */
+    rules: NonEmptyString;
+    /**
+     * How long a round of this sex practice takes.
+     */
+    duration: NonEmptyString;
+    /**
+     * Prerequisites of participants and environment. Do not specify if the
+     * sex practice has no prerequisites.
+     */
+    prerequisites?: NonEmptyString;
+    /**
+     * Effects of a failed *Seduction* check.
+     */
+    failed: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<SexPractice>;

package/lib/types/Skill.d.ts

@@ -4,6 +4,9 @@
 import { Errata } from "./source/_Erratum.js";
 import { PublicationRefs } from "./source/_PublicationRef.js";
 import { ImprovementCost } from "./_ImprovementCost.js";
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "./_NonEmptyString.js";
+import { SkillGroupReference } from "./_SimpleReferences.js";
 import { SkillCheck } from "./_SkillCheck.js";
 /**
  * @title Skill
@@ -34,105 +37,82 @@ export declare type Skill = {
      */
     improvement_cost: ImprovementCost;
     /**
-     * The identifier of the skill group this skill belongs to.
+     * The skill group this skill belongs to.
      */
-    group_id: number;
+    group: SkillGroupReference;
     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;
-        };
-    };
+     */
+    translations: LocaleMap<SkillTranslation>;
+};
+export declare type SkillTranslation = {
+    /**
+     * The name of the skill.
+     */
+    name: NonEmptyString;
+    /**
+     * 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.
+     */
+    applications_input_label?: NonEmptyString;
+    /**
+     * 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.
+     */
+    encumbrance_description?: NonEmptyString;
+    /**
+     * Mentions any tools from the equipment list that are necessary to employ
+     * the skill.
+     */
+    tools?: NonEmptyMarkdown;
+    /**
+     * Gives examples of the effects that various QL might provide.
+     */
+    quality: NonEmptyMarkdown;
+    /**
+     * Lists examples of results for a failed check.
+     */
+    failed: NonEmptyMarkdown;
+    /**
+     * Lists examples of results for a critical success.
+     */
+    critical: NonEmptyMarkdown;
+    /**
+     * Lists examples of results for botches.
+     */
+    botch: NonEmptyMarkdown;
+    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";
-};
+export declare enum ApplicationCategory {
+    BlessedTraditions = "BlessedTraditions",
+    Diseases = "Diseases",
+    Regions = "Regions"
+}
 /**
  * The skill's applications.
  */
-declare type Applications = {
+export declare type Applications = {
     tag: "Derived";
-    /**
-     * A category. All available entries from the specified category will be
-     * included as separate applications.
-     */
-    category: ApplicationCategory;
+    derived: ApplicationCategory;
 } | {
     tag: "Explicit";
-    /**
-     * A list of explicit applications.
-     */
-    list: Application[];
+    explicit: SpecificApplications;
 };
+/**
+ * A list of explicit applications.
+ */
+export declare type SpecificApplications = Application[];
 /**
  * An explicit skill application.
  */
-declare type Application = {
+export declare type Application = {
     /**
      * The skill application's identifier. An unique, increasing integer.
      * @integer
@@ -141,30 +121,21 @@ declare type Application = {
     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;
-        };
-    };
+     */
+    translations: LocaleMap<ApplicationTranslation>;
+};
+export declare type ApplicationTranslation = {
+    /**
+     * The skill application's name.
+     */
+    name: NonEmptyString;
 };
 /**
  * Indicates whether encumbrance gives a penalty for checks with the skill.
  */
-declare type Encumbrance = {
-    tag: "True";
-} | {
-    tag: "False";
-} | {
-    tag: "Maybe";
-};
+export declare enum Encumbrance {
+    True = "True",
+    False = "False",
+    Maybe = "Maybe"
+}
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<Skill>;
-export {};

package/lib/types/Skill.js

@@ -2,4 +2,23 @@
  * @main Skill
  */
 import { validateSchemaCreator } from "../validation/schema.js";
+/**
+ * A category. All available entries from the specified category will be
+ * included as separate applications.
+ */
+export var ApplicationCategory;
+(function (ApplicationCategory) {
+    ApplicationCategory["BlessedTraditions"] = "BlessedTraditions";
+    ApplicationCategory["Diseases"] = "Diseases";
+    ApplicationCategory["Regions"] = "Regions";
+})(ApplicationCategory || (ApplicationCategory = {}));
+/**
+ * Indicates whether encumbrance gives a penalty for checks with the skill.
+ */
+export var Encumbrance;
+(function (Encumbrance) {
+    Encumbrance["True"] = "True";
+    Encumbrance["False"] = "False";
+    Encumbrance["Maybe"] = "Maybe";
+})(Encumbrance || (Encumbrance = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

package/lib/types/SkillGroup.d.ts

@@ -1,6 +1,8 @@
 /**
  * @main SkillGroup
  */
+import { LocaleMap } from "./_LocaleMap.js";
+import { NonEmptyString } from "./_NonEmptyString.js";
 import { SkillCheck } from "./_SkillCheck.js";
 /**
  * @title Skill Group
@@ -18,24 +20,17 @@ export declare type SkillGroup = {
     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;
-        };
-    };
+    translations: LocaleMap<SkillGroupTranslation>;
+};
+export declare type SkillGroupTranslation = {
+    /**
+     * The skill group's name.
+     */
+    name: NonEmptyString;
+    /**
+     * The skill group's long name.
+     */
+    long_name: NonEmptyString;
 };
 export declare const validateSchema: import("../validation/schema.js").TypeValidator<SkillGroup>;