optolith-database-schema 0.11.4 → 0.11.7

package/lib/types/rule/FocusRule_Subject.js

@@ -0,0 +1,12 @@
+/**
+ * @main Subject
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "Subject",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Subject"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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

@@ -0,0 +1,41 @@
+/**
+ * @main OptionalRule
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyMarkdown, NonEmptyString } from "../_NonEmptyString.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Optional Rule
+ */
+export type OptionalRule = {
+    /**
+     * The optional rule's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Has the focus rule not been implemented in Optolith yet? This is also true
+     * if the focus rule does not (currently) apply to any Optolith feature.
+     */
+    is_missing_implementation: boolean;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<OptionalRuleTranslation>;
+};
+export type OptionalRuleTranslation = {
+    /**
+     * The name of the optional rule.
+     */
+    name: NonEmptyString;
+    /**
+     * The description of the optional rule.
+     */
+    description: NonEmptyMarkdown;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<OptionalRule>;

package/lib/types/rule/OptionalRule.js

@@ -0,0 +1,12 @@
+/**
+ * @main OptionalRule
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "OptionalRule",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("OptionalRule"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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

@@ -0,0 +1,75 @@
+/**
+ * @main Publication
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { NonEmptyString } from "../_NonEmptyString.js";
+import { PublicationPrerequisites } from "../_Prerequisite.js";
+/**
+ * @title Publication
+ */
+export type Publication = {
+    /**
+     * The publication's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The publication category.
+     */
+    category: Category;
+    /**
+     * If the publication may contain adult content.
+     */
+    contains_adult_content: boolean;
+    /**
+     * If the publication is not (fully) implemented and thus needs to be excluded
+     * from * stable releases.
+     */
+    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).
+     */
+    translations: LocaleMap<PublicationTranslation>;
+};
+export 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 publication category.
+ */
+export declare enum Category {
+    CoreRules = "CoreRules",
+    ExpansionRules = "ExpansionRules",
+    Sourcebook = "Sourcebook",
+    RegionalSourcebook = "RegionalSourcebook"
+}
+export declare const config: TypeConfig<Publication>;

package/lib/types/source/Publication.js

@@ -0,0 +1,22 @@
+/**
+ * @main Publication
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+/**
+ * The publication category.
+ */
+export var Category;
+(function (Category) {
+    Category["CoreRules"] = "CoreRules";
+    Category["ExpansionRules"] = "ExpansionRules";
+    Category["Sourcebook"] = "Sourcebook";
+    Category["RegionalSourcebook"] = "RegionalSourcebook";
+})(Category = Category || (Category = {}));
+export const config = {
+    name: "Publication",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("Publication"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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

@@ -0,0 +1,26 @@
+/**
+ * @main Errata
+ */
+import { NonEmptyMarkdown } from "../_NonEmptyString.js";
+/**
+ * A list of errata for the entry in the specific language.
+ * @title Errata
+ * @minItems 1
+ */
+export type Errata = Erratum[];
+/**
+ * @title Erratum
+ */
+export 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: NonEmptyMarkdown;
+};

package/lib/types/source/_Erratum.js

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

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

@@ -0,0 +1,151 @@
+/**
+ * @main PublicationRefs
+ */
+import { PublicationIdentifier } from "../_Identifier.js";
+import { LocaleMap } from "../_LocaleMap.js";
+/**
+ * The publications where you can find the entry.
+ * @title Publication References
+ * @minItems 1
+ */
+export type PublicationRefs = PublicationRef[];
+/**
+ * A source reference. It contains the book's publisher identifier and the page
+ * where it occurs. If an entry spans multiple pages, provide the last page as
+ * well.
+ * @title Publication Reference
+ */
+export type PublicationRef = {
+    /**
+     * The publication's identifier.
+     */
+    id: PublicationIdentifier;
+    /**
+     * All occurrences of the entry, identified by IETF language tag (BCP47).
+     */
+    occurrences: LocaleMap<Occurrence>;
+};
+export type Occurrence = SimpleOccurrence | SimpleOccurrences | VersionedOccurrence;
+/**
+ * @title Simple Occurrences
+ * @minItems 1
+ */
+export type SimpleOccurrences = SimpleOccurrence[];
+/**
+ * @title Simple Occurrence
+ */
+export 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.
+     * @integer
+     * @minimum 1
+     */
+    first_page: number;
+    /**
+     * The last page where it occurs. If there is only one page, set this to the
+     * same as `first_page` oder remove it.
+     * @integer
+     * @minimum 2
+     */
+    last_page?: number;
+};
+/**
+ * @title Versioned Occurrence
+ */
+export type VersionedOccurrence = {
+    /**
+     * The initial occurrence of the entry.
+     */
+    initial: InitialOccurrence;
+    /**
+     * Revisions of the entry, resulting in either changed page references or
+     * re-addition or removal of an entry.
+     * @minItems 1
+     */
+    revisions?: Revision[];
+};
+/**
+ * @title Initial Occurrence
+ */
+export 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
+ */
+export type Revision = {
+    tag: "Since";
+    since: Since;
+} | {
+    tag: "Deprecated";
+    deprecated: Deprecation;
+};
+export type Since = {
+    /**
+     * The publication's printing since which the entry is present again or has
+     * changed page references.
+     * @integer
+     * @minimum 2
+     */
+    printing: number;
+    /**
+     * The changed or new page references.
+     * @minItems 1
+     */
+    pages: PageRange[];
+};
+export type Deprecation = {
+    /**
+     * The publication's printing since which the entry has been removed.
+     * @integer
+     * @minimum 2
+     */
+    printing: number;
+};
+/**
+ * @title Page Range
+ */
+export 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.
+     */
+    first_page: Page;
+    /**
+     * The last page where it occurs. If there is only one page, set this to the
+     * same as `first_page` oder remove it.
+     */
+    last_page?: Page;
+};
+/**
+ * @title Page
+ */
+export type Page = {
+    tag: "InsideCoverFront";
+    inside_cover_front: {};
+} | {
+    tag: "InsideCoverBack";
+    inside_cover_back: {};
+} | {
+    tag: "Numbered";
+    numbered: NumberedPage;
+};
+/**
+ * The page number.
+ * @integer
+ */
+export type NumberedPage = number;

package/lib/types/source/_PublicationRef.js

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

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

@@ -0,0 +1,52 @@
+/**
+ * @main AdvancedCombatSpecialAbility
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Advanced Combat Special Ability
+ */
+export type AdvancedCombatSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    usage_type: Activatable.CombatSpecialAbilityUsageType;
+    select_options?: Activatable.SelectOptions;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    maximum?: Activatable.Maximum;
+    penalty?: Activatable.Penalty;
+    prerequisites?: GeneralPrerequisites;
+    combat_techniques: Activatable.ApplicableCombatTechniques;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AdvancedCombatSpecialAbilityTranslation>;
+};
+export type AdvancedCombatSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    /**
+     * @deprecated
+     */
+    penalty?: string;
+    /**
+     * The AP value. It is only used if the text cannot be generated from the
+     * given information.
+     */
+    ap_value?: Activatable.AdventurePointsValueReplacement;
+    /**
+     * A string that gets appended to the default AP Value text with a preceding
+     * space. This always happens if present, even if the generated AP Value text
+     * is replaced.
+     */
+    ap_value_append?: Activatable.AdventurePointsValueAppend;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<AdvancedCombatSpecialAbility>;

package/lib/types/specialAbility/AdvancedCombatSpecialAbility.js

@@ -0,0 +1,12 @@
+/**
+ * @main AdvancedCombatSpecialAbility
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "AdvancedCombatSpecialAbility",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("AdvancedCombatSpecialAbility"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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

@@ -0,0 +1,34 @@
+/**
+ * @main AdvancedKarmaSpecialAbility
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+* @title Advanced Karma Special Ability
+*/
+export type AdvancedKarmaSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AdvancedKarmaSpecialAbilityTranslation>;
+};
+export type AdvancedKarmaSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<AdvancedKarmaSpecialAbility>;

package/lib/types/specialAbility/AdvancedKarmaSpecialAbility.js

@@ -0,0 +1,12 @@
+/**
+ * @main AdvancedKarmaSpecialAbility
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "AdvancedKarmaSpecialAbility",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("AdvancedKarmaSpecialAbility"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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

@@ -0,0 +1,34 @@
+/**
+ * @main AdvancedMagicalSpecialAbility
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Advanced Magical Special Ability
+ */
+export type AdvancedMagicalSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AdvancedMagicalSpecialAbilityTranslation>;
+};
+export type AdvancedMagicalSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<AdvancedMagicalSpecialAbility>;

package/lib/types/specialAbility/AdvancedMagicalSpecialAbility.js

@@ -0,0 +1,12 @@
+/**
+ * @main AdvancedMagicalSpecialAbility
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "AdvancedMagicalSpecialAbility",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("AdvancedMagicalSpecialAbility"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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

@@ -0,0 +1,34 @@
+/**
+ * @main AdvancedSkillSpecialAbility
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Advanced Skill Special Ability
+ */
+export type AdvancedSkillSpecialAbility = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    skill_applications?: Activatable.SkillApplications;
+    skill_uses?: Activatable.SkillUses;
+    maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AdvancedSkillSpecialAbilityTranslation>;
+};
+export type AdvancedSkillSpecialAbilityTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<AdvancedSkillSpecialAbility>;

package/lib/types/specialAbility/AdvancedSkillSpecialAbility.js

@@ -0,0 +1,12 @@
+/**
+ * @main AdvancedSkillSpecialAbility
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "AdvancedSkillSpecialAbility",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("AdvancedSkillSpecialAbility"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};

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

@@ -0,0 +1,38 @@
+/**
+ * @main AncestorGlyph
+ */
+import { TypeConfig } from "../../typeConfig.js";
+import * as Activatable from "../_Activatable.js";
+import { LocaleMap } from "../_LocaleMap.js";
+import { GeneralPrerequisites } from "../_Prerequisite.js";
+import { Errata } from "../source/_Erratum.js";
+import { PublicationRefs } from "../source/_PublicationRef.js";
+/**
+ * @title Ancestor Glyph
+ */
+export type AncestorGlyph = {
+    id: Activatable.Id;
+    levels?: Activatable.Levels;
+    select_options?: Activatable.SelectOptions;
+    maximum?: Activatable.Maximum;
+    prerequisites?: GeneralPrerequisites;
+    /**
+     * The AE cost of the ancestor glyph.
+     * @integer
+     * @minimum 1
+     */
+    ae_cost: number;
+    ap_value: Activatable.AdventurePointsValue;
+    src: PublicationRefs;
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     */
+    translations: LocaleMap<AncestorGlyphTranslation>;
+};
+export type AncestorGlyphTranslation = {
+    name: Activatable.Name;
+    name_in_library?: Activatable.NameInLibrary;
+    rules: Activatable.Rules;
+    errata?: Errata;
+};
+export declare const config: TypeConfig<AncestorGlyph>;

package/lib/types/specialAbility/AncestorGlyph.js

@@ -0,0 +1,12 @@
+/**
+ * @main AncestorGlyph
+ */
+import { todo } from "../../validation/builders/integrity.js";
+import { createSchemaValidator } from "../../validation/builders/schema.js";
+import { getFIlenamePrefixAsNumericId } from "../../validation/filename.js";
+export const config = {
+    name: "AncestorGlyph",
+    id: getFIlenamePrefixAsNumericId,
+    integrityValidator: todo("AncestorGlyph"),
+    schemaValidator: createSchemaValidator(import.meta.url),
+};