optolith-database-schema 0.2.4 → 0.4.1

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

@@ -3,6 +3,9 @@
  */
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../_NonEmptyString.js";
+import { Relevance } from "./_Rule.js";
 /**
  * @title Optional Rule
  */
@@ -23,44 +26,18 @@ export declare type OptionalRule = {
     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;
-        };
-    };
+    translations: LocaleMap<OptionalRuleTranslation>;
 };
-/**
- * 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";
+export declare type OptionalRuleTranslation = {
+    /**
+     * The name of the optional rule.
+     */
+    name: NonEmptyString;
     /**
-     * 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.
+     * The description of the optional rule.
      */
-    isMissingImplementation?: boolean;
+    description: NonEmptyMarkdown;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<OptionalRule>;
-export {};

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

@@ -0,0 +1,20 @@
+/**
+ * The relevance of the 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.
+ */
+export declare type Relevance = {
+    tag: "Extraneous";
+    extraneous: {};
+} | {
+    tag: "Linked";
+    linked: LinkedRelevance;
+};
+export declare type LinkedRelevance = {
+    /**
+     * Does the optional rule have an impact on character creation or character
+     * sheet and this effect has not been implemented in Optolith yet?
+     */
+    is_missing_implementation: boolean;
+};

package/lib/types/rule/_Rule.js

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

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

@@ -1,6 +1,8 @@
 /**
  * @main Publication
  */
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
 import { PublicationPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Publication
@@ -17,75 +19,56 @@ export declare type Publication = {
      */
     category: Category;
     /**
-     * The age the content is restricted to.
+     * If the publication may contain adult content.
      */
-    age_restriction: AgeRestriction;
+    contains_adult_content: boolean;
     /**
-     * The publication is not (fully) implemented and thus needs to be excluded
+     * If the publication is not (fully) implemented and thus needs to be excluded
      * from * stable releases.
      */
-    is_missing_implementation?: boolean;
+    is_missing_implementation: boolean;
     /**
      * The specific other publications this publication depends on data from.
      */
     prerequisites?: PublicationPrerequisites;
     /**
      * All translations for the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    translations: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: {
-            /**
-             * The publisher's publication identifier.
-             * @minLength 1
-             * @example US25001
-             */
-            id?: string;
-            /**
-             * The publication's name.
-             * @minLength 1
-             */
-            name: string;
-            /**
-             * The publication's abbreviation.
-             * @minLength 1
-             */
-            abbreviation: string;
-            /**
-             * The publication's release date.
-             * @format date
-             */
-            release_date?: string;
-            /**
-             * This publication translation is not (fully) implemented and thus needs to
-             * be excluded from stable releases.
-             */
-            is_missing_implementation?: boolean;
-        };
-    };
+    translations: LocaleMap<PublicationTranslation>;
 };
-/**
- * The publication category.
- */
-declare type Category = {
-    tag: "CoreRules";
-} | {
-    tag: "ExpansionRules";
-} | {
-    tag: "Sourcebook";
-} | {
-    tag: "RegionalSourcebook";
+export declare type PublicationTranslation = {
+    /**
+     * The publisher's publication identifier.
+     * @minLength 1
+     * @example US25001
+     */
+    id?: string;
+    /**
+     * The publication's name.
+     */
+    name: NonEmptyString;
+    /**
+     * The publication's abbreviation.
+     */
+    abbreviation: NonEmptyString;
+    /**
+     * The publication's release date.
+     * @format date
+     */
+    release_date?: string;
+    /**
+     * If this publication translation is not (fully) implemented and thus needs
+     * to be excluded from stable releases.
+     */
+    is_missing_implementation: boolean;
 };
 /**
- * The age the content is restricted to.
+ * The publication category.
  */
-declare type AgeRestriction = {
-    tag: "Adult";
-} | {
-    tag: "None";
-};
+export declare enum Category {
+    CoreRules = "CoreRules",
+    ExpansionRules = "ExpansionRules",
+    Sourcebook = "Sourcebook",
+    RegionalSourcebook = "RegionalSourcebook"
+}
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<Publication>;
-export {};

package/lib/types/source/Publication.js

@@ -2,4 +2,14 @@
  * @main Publication
  */
 import { validateSchemaCreator } from "../../validation/schema.js";
+/**
+ * The publication category.
+ */
+export var Category;
+(function (Category) {
+    Category["CoreRules"] = "CoreRules";
+    Category["ExpansionRules"] = "ExpansionRules";
+    Category["Sourcebook"] = "Sourcebook";
+    Category["RegionalSourcebook"] = "RegionalSourcebook";
+})(Category || (Category = {}));
 export const validateSchema = validateSchemaCreator(import.meta.url);

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

@@ -1,6 +1,7 @@
 /**
  * @main Errata
  */
+import { NonEmptyMarkdown } from "../_NonEmptyString.js";
 /**
  * A list of errata for the entry in the specific language.
  * @title Errata
@@ -21,5 +22,5 @@ export declare type Erratum = {
      * @markdown
      * @minLength 1
      */
-    description: string;
+    description: NonEmptyMarkdown;
 };

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

@@ -1,6 +1,7 @@
 /**
  * @main PublicationRefs
  */
+import { LocaleMap } from "../_LocaleMap.js";
 /**
  * The publications where you can find the entry.
  * @title Publication References
@@ -22,25 +23,19 @@ export declare type PublicationRef = {
     id: number;
     /**
      * All occurrences of the entry, identified by IETF language tag (BCP47).
-     * @minProperties 1
      */
-    occurrences: {
-        /**
-         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
-         */
-        [localeId: string]: Occurrence;
-    };
+    occurrences: LocaleMap<Occurrence>;
 };
-declare type Occurrence = SimpleOccurrence | SimpleOccurrences | VersionedOccurrence;
+export declare type Occurrence = SimpleOccurrence | SimpleOccurrences | VersionedOccurrence;
 /**
  * @title Simple Occurrences
  * @minItems 1
  */
-declare type SimpleOccurrences = SimpleOccurrence[];
+export declare type SimpleOccurrences = SimpleOccurrence[];
 /**
  * @title Simple Occurrence
  */
-declare type SimpleOccurrence = {
+export declare type SimpleOccurrence = {
     /**
      * The page where it occurs. If the entry spans multiple pages, use this as
      * the first page and `last_page` as the last page.
@@ -59,25 +54,11 @@ declare type SimpleOccurrence = {
 /**
  * @title Versioned Occurrence
  */
-declare type VersionedOccurrence = {
+export declare type VersionedOccurrence = {
     /**
      * The initial occurrence of the entry.
-     * @title Initial
      */
-    initial: {
-        /**
-         * The publication's printing since which the entry is present. Leave
-         * empty if present since the beginning.
-         * @integer
-         * @minimum 2
-         */
-        printing?: number;
-        /**
-         * The initial page references.
-         * @minItems 1
-         */
-        pages: PageRange[];
-    };
+    initial: InitialOccurrence;
     /**
      * Revisions of the entry, resulting in either changed page references or
      * re-addition or removal of an entry.
@@ -85,13 +66,36 @@ declare type VersionedOccurrence = {
      */
     revisions?: Revision[];
 };
+/**
+ * @title Initial Occurrence
+ */
+export declare type InitialOccurrence = {
+    /**
+     * The publication's printing since which the entry is present. Leave
+     * empty if present since the beginning.
+     * @integer
+     * @minimum 2
+     */
+    printing?: number;
+    /**
+     * The initial page references.
+     * @minItems 1
+     */
+    pages: PageRange[];
+};
 /**
  * A revision of the entry, resulting in either changed page references or
  * re-addition or removal of an entry.
  * @title Revision
  */
-declare type Revision = {
+export declare type Revision = {
     tag: "Since";
+    since: Since;
+} | {
+    tag: "Deprecated";
+    deprecated: Deprecation;
+};
+export declare type Since = {
     /**
      * The publication's printing since which the entry is present again or has
      * changed page references.
@@ -104,8 +108,8 @@ declare type Revision = {
      * @minItems 1
      */
     pages: PageRange[];
-} | {
-    tag: "Deprecated";
+};
+export declare type Deprecation = {
     /**
      * The publication's printing since which the entry has been removed.
      * @integer
@@ -116,7 +120,7 @@ declare type Revision = {
 /**
  * @title Page Range
  */
-declare type PageRange = {
+export declare type PageRange = {
     /**
      * The page where it occurs. If the entry spans multiple pages, use this as
      * the first page and `last_page` as the last page.
@@ -131,16 +135,18 @@ declare type PageRange = {
 /**
  * @title Page
  */
-declare type Page = {
+export declare type Page = {
     tag: "InsideCoverFront";
+    inside_cover_front: {};
 } | {
     tag: "InsideCoverBack";
+    inside_cover_back: {};
 } | {
     tag: "Numbered";
-    /**
-     * The page number.
-     * @integer
-     */
-    number: number;
+    numbered: NumberedPage;
 };
-export {};
+/**
+ * The page number.
+ * @integer
+ */
+export declare type NumberedPage = number;

package/lib/types/specialAbility/AdvancedCombatSpecialAbility.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Advanced Combat Special Ability
@@ -11,7 +12,7 @@ import { GeneralPrerequisites } from "../_Prerequisite.js";
 export declare type AdvancedCombatSpecialAbility = {
     id: Activatable.Id;
     levels?: Activatable.Levels;
-    usage_type: Activatable.CombatSpecialAbilityType;
+    usage_type: Activatable.CombatSpecialAbilityUsageType;
     select_options?: Activatable.SelectOptions;
     skill_applications?: Activatable.SkillApplications;
     skill_uses?: Activatable.SkillUses;
@@ -23,22 +24,17 @@ export declare type AdvancedCombatSpecialAbility = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            /**
-             * @deprecated
-             */
-            penalty?: string;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<AdvancedCombatSpecialAbilityTranslation>;
+};
+export declare type AdvancedCombatSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    /**
+     * @deprecated
+     */
+    penalty?: string;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AdvancedCombatSpecialAbility>;

package/lib/types/specialAbility/AdvancedKarmaSpecialAbility.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
 * @title Advanced Karma Special Ability
@@ -20,18 +21,13 @@ export declare type AdvancedKarmaSpecialAbility = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<AdvancedKarmaSpecialAbilityTranslation>;
+};
+export declare type AdvancedKarmaSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AdvancedKarmaSpecialAbility>;

package/lib/types/specialAbility/AdvancedMagicalSpecialAbility.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Advanced Magical Special Ability
@@ -20,18 +21,13 @@ export declare type AdvancedMagicalSpecialAbility = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<AdvancedMagicalSpecialAbilityTranslation>;
+};
+export declare type AdvancedMagicalSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AdvancedMagicalSpecialAbility>;

package/lib/types/specialAbility/AdvancedSkillSpecialAbility.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Advanced Skill Special Ability
@@ -20,18 +21,13 @@ export declare type AdvancedSkillSpecialAbility = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<AdvancedSkillSpecialAbilityTranslation>;
+};
+export declare type AdvancedSkillSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AdvancedSkillSpecialAbility>;

package/lib/types/specialAbility/AncestorGlyph.d.ts

@@ -4,6 +4,7 @@
 import { Errata } from "../source/_Erratum.js";
 import { PublicationRefs } from "../source/_PublicationRef.js";
 import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
 import { GeneralPrerequisites } from "../_Prerequisite.js";
 /**
  * @title Ancestor Glyph
@@ -24,18 +25,13 @@ export declare type AncestorGlyph = {
     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]: {
-            name: Activatable.Name;
-            name_in_library?: Activatable.NameInLibrary;
-            rules: Activatable.Rules;
-            errata?: Errata;
-        };
-    };
+    translations: LocaleMap<AncestorGlyphTranslation>;
+};
+export declare type AncestorGlyphTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
 };
 export declare const validateSchema: import("../../validation/schema.js").TypeValidator<AncestorGlyph>;