optolith-database-schema 0.0.1 → 0.0.4

package/CHANGELOG.md

@@ -2,6 +2,35 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.0.4](https://github.com/elyukai/optolith-database-schema/compare/v0.0.3...v0.0.4) (2022-03-06)
+
+
+### Bug Fixes
+
+* broken markdown newlines ([87c5ff2](https://github.com/elyukai/optolith-database-schema/commit/87c5ff243c6df1a9dd966167c85dd41b45c36369))
+* cost map should allow different translations ([f65683f](https://github.com/elyukai/optolith-database-schema/commit/f65683fc45f2c9f16d1571ec9fcbc449eee042b1))
+
+### [0.0.3](https://github.com/elyukai/optolith-database-schema/compare/v0.0.2...v0.0.3) (2022-03-05)
+
+
+### Features
+
+* blessings ([8586a40](https://github.com/elyukai/optolith-database-schema/commit/8586a4026615ff6ebdc6cfb1e988d71828e5cd23))
+* cantrips ([50397e8](https://github.com/elyukai/optolith-database-schema/commit/50397e83c9322dd36ef0cd28d2924128a6133a27))
+* pact categories ([7b9cbc6](https://github.com/elyukai/optolith-database-schema/commit/7b9cbc66a5f13b40536d03a90f726fd9aff8c15a))
+
+
+### Bug Fixes
+
+* liturgies do not have properties ([9b2c41d](https://github.com/elyukai/optolith-database-schema/commit/9b2c41dd9996abeac627b652cdb6ce0226760f2a))
+
+### [0.0.2](https://github.com/elyukai/optolith-database-schema/compare/v0.0.1...v0.0.2) (2022-03-05)
+
+
+### Features
+
+* finish basic activatable skills ([ede33df](https://github.com/elyukai/optolith-database-schema/commit/ede33df9e897cb58f19f58c4e8d5619c2f9be0e0))
+
 ### 0.0.1 (2022-03-05)
 
 

package/lib/types/Blessing.d.ts

@@ -0,0 +1,124 @@
+/**
+ * @main Blessing
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Duration, TargetCategory } from "./_ActivatableSkill";
+/**
+ * @title Blessing
+ */
+export declare type Blessing = {
+    /**
+     * The blessing's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Measurable parameters of a blessing.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory.T;
+    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 blessing.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description.
+             * @markdown
+             * @minLength 1
+             */
+            effect: string;
+            /**
+             * @deprecated
+             */
+            range: string;
+            /**
+             * @deprecated
+             */
+            duration: string;
+            /**
+             * @deprecated
+             */
+            target: string;
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a blessing.
+ */
+declare type PerformanceParameters = {
+    range: {
+        tag: "Self";
+    } | {
+        tag: "Touch";
+    } | {
+        tag: "Fixed";
+        /**
+         * The range in steps/m.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    };
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * The (unitless) duration.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The duration unit.
+         */
+        unit: Duration.Unit;
+    } | {
+        tag: "Indefinite";
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * A description of the duration.
+                 */
+                description: {
+                    /**
+                     * The full description of the duration.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of the duration for use in small areas
+                     * (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+};
+export {};

package/lib/types/Blessing.js

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

package/lib/types/Cantrip.d.ts

@@ -0,0 +1,220 @@
+/**
+ * @main Spell
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Duration, Effect, TargetCategory } from "./_ActivatableSkill";
+import { Enhancements } from "./_Enhancements";
+import { ImprovementCost } from "./_ImprovementCost";
+/**
+ * @title Spell
+ */
+export declare type Spell = {
+    /**
+     * The spell's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * Measurable parameters of a spell.
+     */
+    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;
+    /**
+     * A note specifying the dissemination of the cantrip in different traditions.
+     * Sometimes a cantrip is exclusively available to one or more specific
+     * traditions, but usually one the academies and traditions are listed the
+     * cantrip is most commonly teached in.
+     */
+    note: {
+        tag: "Exclusive";
+        /**
+         * The traditions the cantrip is exclusively available to.
+         * @minItems 1
+         * @uniqueItems
+         */
+        traditions: {
+            /**
+             * The magical tradition's identifier.
+             * @integer
+             * @minimum 2
+             */
+            id: number;
+        }[];
+    } | {
+        tag: "Common";
+        /**
+         * The academies and traditions the cantrip is commonly teached in.
+         * @minItems 1
+         * @uniqueItems
+         */
+        list: CommonNote[];
+    };
+    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 spell.
+             * @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;
+        };
+    };
+    enhancements?: Enhancements;
+};
+/**
+ * Measurable parameters of a blessing.
+ */
+declare type PerformanceParameters = {
+    range: {
+        tag: "Self";
+    } | {
+        tag: "Touch";
+    } | {
+        tag: "Fixed";
+        /**
+         * The range in steps/m.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * If `true`, the range is a radius.
+         */
+        is_radius?: true;
+    };
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * If `true`, the duration is a maximum duration.
+         */
+        is_maximum?: true;
+        /**
+         * The (unitless) duration.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The duration unit.
+         */
+        unit: Duration.Unit;
+    } | {
+        tag: "DuringLovemaking";
+        /**
+         * The duration in rounds.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    } | {
+        tag: "Indefinite";
+        /**
+         * All translations for the entry, identified by IETF language tag (BCP47).
+         * @minProperties 1
+         */
+        translations: {
+            /**
+             * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+             */
+            [localeId: string]: {
+                /**
+                 * A description of the duration.
+                 */
+                description: {
+                    /**
+                     * The full description of the duration.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of the duration for use in small areas
+                     * (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+};
+export declare type CommonNote = {
+    tag: "Academy";
+    /**
+     * The academy's curriculum identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+} | {
+    tag: "Tradition";
+    /**
+     * The magical tradition's identifier.
+     * @integer
+     * @minimum 2
+     */
+    id: number;
+};
+export {};

package/lib/types/Cantrip.js

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

package/lib/types/Ceremony.d.ts

@@ -0,0 +1,144 @@
+/**
+ * @main Ceremony
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Effect, SlowPerformanceParameters, TargetCategory } from "./_ActivatableSkill";
+import { Enhancements } from "./_Enhancements";
+import { ImprovementCost } from "./_ImprovementCost";
+import { GroupCollection } from "./_Prerequisite";
+import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck";
+/**
+ * @title Ceremony
+ */
+export declare type Ceremony = {
+    /**
+     * The ceremony'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 ceremony.
+     */
+    parameters: SlowPerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory.T;
+    /**
+     * The tradition(s) the ceremony is available for. Note that general aspects
+     * do not have an associated tradition and thus need to be defined in a
+     * special way.
+     * @minItems 1
+     */
+    traditions: Tradition[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    prerequisites?: GroupCollection.Liturgy;
+    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 ceremony.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * A compressed name of the ceremony for use in small areas (e.g. on
+             * character sheet). Should only be defined if the `name` does not fit on
+             * character sheet.
+             * @minLength 1
+             */
+            name_compressed?: 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;
+        };
+    };
+    enhancements?: Enhancements;
+};
+export declare type Tradition = {
+    tag: "GeneralAspect";
+    /**
+     * A general aspect's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+} | {
+    tag: "Tradition";
+    /**
+     * The blessed tradition's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The aspect(s) from the tradition the ceremony belongs to. Note that not
+     * all traditions have aspects.
+     * @minItems 1
+     * @maxItems 2
+     */
+    aspects?: {
+        /**
+         * The aspect's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    }[];
+};

package/lib/types/Ceremony.js

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

package/lib/types/LiturgicalChant.d.ts

@@ -0,0 +1,144 @@
+/**
+ * @main LiturgicalChant
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Effect, FastPerformanceParameters, TargetCategory } from "./_ActivatableSkill";
+import { Enhancements } from "./_Enhancements";
+import { ImprovementCost } from "./_ImprovementCost";
+import { GroupCollection } from "./_Prerequisite";
+import { SkillCheck, SkillCheckPenalty } from "./_SkillCheck";
+/**
+ * @title Liturgical Chant
+ */
+export declare type LiturgicalChant = {
+    /**
+     * The liturgical chant'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 liturgical chant.
+     */
+    parameters: FastPerformanceParameters;
+    /**
+     * The target category – the kind of creature or object – the skill affects.
+     */
+    target: TargetCategory.T;
+    /**
+     * The tradition(s) the liturgical chant is available for. Note that general
+     * aspects do not have an associated tradition and thus need to be defined in
+     * a special way.
+     * @minItems 1
+     */
+    traditions: Tradition[];
+    /**
+     * States which column is used to improve the skill.
+     */
+    improvement_cost: ImprovementCost;
+    prerequisites?: GroupCollection.Liturgy;
+    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 liturgical chant.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * A compressed name of the liturgical chant for use in small areas (e.g.
+             * on character sheet). Should only be defined if the `name` does not fit
+             * on character sheet.
+             * @minLength 1
+             */
+            name_compressed?: 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;
+        };
+    };
+    enhancements?: Enhancements;
+};
+export declare type Tradition = {
+    tag: "GeneralAspect";
+    /**
+     * A general aspect's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+} | {
+    tag: "Tradition";
+    /**
+     * The blessed tradition's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The aspect(s) from the tradition the ceremony belongs to. Note that not
+     * all traditions have aspects.
+     * @minItems 1
+     * @maxItems 2
+     */
+    aspects?: {
+        /**
+         * The aspect's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: number;
+    }[];
+};

package/lib/types/LiturgicalChant.js

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