optolith-database-schema 0.1.0 → 0.1.3

package/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 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.1.3](https://github.com/elyukai/optolith-database-schema/compare/v0.1.2...v0.1.3) (2022-03-09)
+
+
+### Features
+
+* first concept of penalties for combat-related special abilities ([d79d3b3](https://github.com/elyukai/optolith-database-schema/commit/d79d3b3752252342795400c905e2944d1234bd37))
+
+
+### Bug Fixes
+
+* remove generic numeric identifier maximum ([e121081](https://github.com/elyukai/optolith-database-schema/commit/e1210810f9cdbf8a720d0e12d5ec6ac21010a8dd))
+
+### [0.1.2](https://github.com/elyukai/optolith-database-schema/compare/v0.1.1...v0.1.2) (2022-03-09)
+
+
+### Bug Fixes
+
+* output for namespaced imports ([0bf0c9d](https://github.com/elyukai/optolith-database-schema/commit/0bf0c9d8713e0449342b2b01309eb38b3b1013a7))
+
+### [0.1.1](https://github.com/elyukai/optolith-database-schema/compare/v0.1.0...v0.1.1) (2022-03-09)
+
+
+### Features
+
+* familiar's tricks ([f8f88c9](https://github.com/elyukai/optolith-database-schema/commit/f8f88c9ab3c3339c4e26830623052d09924c4102))
+* trade secrets ([c834c31](https://github.com/elyukai/optolith-database-schema/commit/c834c31de87ce830d34c4cf9c0f60dcfb5a4d3ca))
+
 ## [0.1.0](https://github.com/elyukai/optolith-database-schema/compare/v0.0.4...v0.1.0) (2022-03-08)
 
 

package/lib/types/FamiliarsTrick.d.ts

@@ -0,0 +1,333 @@
+/**
+ * @main FamiliarsTrick
+ */
+import { Errata } from "./source/_Erratum";
+import { PublicationRefs } from "./source/_PublicationRef";
+import { Duration } from "./_ActivatableSkill";
+/**
+ * @title Familiar's Trick
+ */
+export declare type FamiliarsTrick = {
+    /**
+     * The familiar's trick's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The animal types this trick is available to. Either it is available to all
+     * or only a list of specific animal types.
+     */
+    animal_types: {
+        tag: "All";
+    } | {
+        tag: "Specific";
+        /**
+         * The list of specific animal types.
+         * @minItems 1
+         */
+        list: {
+            /**
+             * The animal type's identifier.
+             * @integer
+             * @minimum 1
+             */
+            id: number;
+        }[];
+    };
+    /**
+     * Measurable parameters of a familiar's trick.
+     */
+    parameters: PerformanceParameters;
+    /**
+     * The property of the trick.
+     */
+    property: {
+        tag: "Fixed";
+        /**
+         * The property's identifier.
+         * @integer
+         * @minimum 1
+         */
+        id: 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 property.
+                 */
+                description: {
+                    /**
+                     * The full description of the property.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of the property for use in small areas
+                     * (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+    /**
+     * The AP value the familiar has to pay for. It may also be that a specific is
+     * known by all familiar by default.
+     */
+    ap_value: {
+        tag: "Fixed";
+        /**
+         * The adventure points value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+    } | {
+        tag: "Default";
+    };
+    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 familiar's trick.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The effect description.
+             * @markdown
+             * @minLength 1
+             */
+            effect: string;
+            /**
+             * @deprecated
+             */
+            cost: {
+                full: string;
+                abbr: string;
+            };
+            /**
+             * @deprecated
+             */
+            duration: {
+                full: string;
+                abbr: string;
+            };
+            errata?: Errata;
+        };
+    };
+};
+/**
+ * Measurable parameters of a familiar's trick.
+ */
+declare type PerformanceParameters = {
+    tag: "OneTime";
+    cost: {
+        tag: "Fixed";
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The interval in which you have to pay the AE cost again.
+         */
+        interval?: Duration.UnitValue;
+        /**
+         * 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]: {
+                /**
+                 *
+                 */
+                per?: {
+                    /**
+                     * The full countable entity name.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * The compressed countable entity name.
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    } | {
+        tag: "All";
+        /**
+         * The minimum AE the familiar has to have.
+         * @integer
+         * @minimum 1
+         */
+        minimum?: 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 AE cost.
+                 */
+                description: {
+                    /**
+                     * The full description of the AE cost.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed description of the AE cost for use in small areas
+                     * (e.g. on character sheet).
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    };
+    duration: {
+        tag: "Immediate";
+    } | {
+        tag: "Fixed";
+        /**
+         * If the duration is the maximum duration, so it may end earlier.
+         */
+        is_maximum?: boolean;
+        /**
+         * The (unitless) duration.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The duration unit.
+         */
+        unit: Duration.Unit;
+        /**
+         * 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]: {
+                /**
+                 * A replacement string.
+                 */
+                replacement?: {
+                    /**
+                     * The full replacement string. It can contain `$1`, which is
+                     * going to be replaced with the generated duration string, so
+                     * additional information can be provided without duplicating
+                     * concrete numeric values.
+                     * @minLength 1
+                     */
+                    default: string;
+                    /**
+                     * A compressed replacement string for use in small areas (e.g. on
+                     * character sheet). It can contain `$1`, which is going to be
+                     * replaced with the generated duration string, so additional
+                     * information can be provided without duplicating concrete
+                     * numeric values.
+                     * @minLength 1
+                     */
+                    compressed: string;
+                };
+            };
+        };
+    } | {
+        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;
+                };
+            };
+        };
+    };
+} | {
+    tag: "OneTimeInterval";
+    cost: {
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The duration granted/added by paying the given AE cost.
+         */
+        interval: Duration.UnitValue;
+    };
+} | {
+    tag: "Sustained";
+    cost: {
+        /**
+         * The AE cost value.
+         * @integer
+         * @minimum 1
+         */
+        value: number;
+        /**
+         * The interval in which you have to pay the AE cost again.
+         */
+        interval: Duration.UnitValue;
+    };
+};
+export {};

package/lib/types/FamiliarsTrick.js

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

package/lib/types/FamiliarsTrick_AnimalType.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @main AnimalType
+ */
+/**
+ * @title Animal Type
+ */
+export declare type AnimalType = {
+    /**
+     * The animal type'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 animal type name.
+             * @minLength 1
+             */
+            name: string;
+        };
+    };
+};

package/lib/types/FamiliarsTrick_AnimalType.js

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

package/lib/types/_Activatable.d.ts

@@ -182,7 +182,130 @@ export declare type SkillUses = {
 /**
  * The penalty the special ability gives when used.
  */
-export declare type Penalty = "";
+export declare type Penalty = {
+    tag: "Single";
+    /**
+     * The penalty value.
+     * @integer
+     */
+    value: number;
+    /**
+     * Set to `true` if the penalty applies to the parry instead of the attack.
+     */
+    applies_to_parry?: true;
+} | {
+    tag: "ByHandedness";
+    /**
+     * The penalty value for one-handed weapons.
+     * @integer
+     */
+    one_handed: number;
+    /**
+     * The penalty value for two-handed weapons.
+     * @integer
+     */
+    two_handed: number;
+    /**
+     * Set to `true` if the penalty applies to the parry instead of the attack.
+     */
+    applies_to_parry?: true;
+} | {
+    tag: "ByActivation";
+    /**
+     * The penalty value if the entry has been bought by the character.
+     * @integer
+     */
+    active: number;
+    /**
+     * The penalty value if the entry has not been bought by the character.
+     * @integer
+     */
+    inactive: number;
+    /**
+     * Set to `true` if the penalty applies to the parry instead of the attack.
+     */
+    applies_to_parry?: true;
+} | {
+    tag: "Selection";
+    options: {
+        tag: "Specific";
+        /**
+         * The list of specific penalty options.
+         * @minItems 2
+         * @uniqueItems
+         */
+        list: {
+            /**
+             * The penalty value.
+             * @integer
+             */
+            value: number;
+        }[];
+    } | {
+        tag: "Range";
+        /**
+         * The minimum penalty value.
+         * @integer
+         */
+        minimum: number;
+        /**
+         * The maximum penalty value.
+         * @integer
+         */
+        maximum: number;
+    };
+} | {
+    tag: "ByLevel";
+    /**
+     * A continuous range of penalties for each level. The first element is the
+     * penalty for the first level, the second element is the penalty for the
+     * second level, and so on.
+     * @minItems 2
+     */
+    levels: {
+        /**
+         * The penalty value for this level.
+         * @integer
+         */
+        value: number;
+    }[];
+    /**
+     * The identifier of the combat-related special ability of which the level
+     * defines the penalty instead.
+     */
+    external_id?: Identifier.Group.CombatRelatedSpecialAbility;
+} | {
+    tag: "ByAttack";
+    /**
+     * A list of penalties for subsequent attacks. The first element is the
+     * penalty for the first attack, the second element is the penalty for the
+     * second attack, and so on. The order of the first element may be changed
+     * using `initial_order`, so that e.g. if set to `2`, the first element is
+     * the penalty for the second attack, the second element is the penalty for
+     * the third attack, and so on.
+     * @minItems 1
+     */
+    list: {
+        /**
+         * The penalty value for this order.
+         * @integer
+         */
+        value: number;
+    }[];
+    /**
+     * The order of the first element in the `list` of penalties.
+     */
+    initial_order?: number;
+    /**
+     * Set if a predefined different word should be used instead of the word
+     * `attack` for display purposes.
+     */
+    attack_replacement?: {
+        tag: "Throw";
+    };
+} | {
+    tag: "DependsOnHitZone";
+};
 /**
  * The AE Cost.
  */

package/lib/types/_Identifier.d.ts

@@ -48,6 +48,12 @@ export declare namespace Identifier {
             RingEnchantment = "RingEnchantment",
             ChronicleEnchantment = "ChronicleEnchantment"
         }
+        enum CombatRelatedSpecialAbility {
+            CombatSpecialAbility = "CombatSpecialAbility",
+            CombatStyleSpecialAbility = "CombatStyleSpecialAbility",
+            AdvancedCombatSpecialAbility = "AdvancedCombatSpecialAbility",
+            CommandSpecialAbility = "CommandSpecialAbility"
+        }
         enum Rated {
             Attribute = "Attribute",
             Skill = "Skill",
@@ -73,12 +79,12 @@ export declare namespace Identifier {
          * The referenced entry's numeric identifier.
          * @integer
          * @minimum 1
-         * @maximum 8
          */
         value: number;
     };
     namespace Group {
         type Activatable = Tagged<Tag.Activatable>;
+        type CombatRelatedSpecialAbility = Tagged<Tag.CombatRelatedSpecialAbility>;
         type Rated = Tagged<Tag.Rated>;
         type AdvancedSpecialAbilityRestrictedOption = Tagged<Tag.AdvancedSpecialAbilityRestrictedOption>;
         type CombatTechnique = Tagged<Tag.CombatTechnique>;

package/lib/types/_Identifier.js

@@ -51,6 +51,13 @@ export var Identifier;
             Activatable["RingEnchantment"] = "RingEnchantment";
             Activatable["ChronicleEnchantment"] = "ChronicleEnchantment";
         })(Activatable = Tag.Activatable || (Tag.Activatable = {}));
+        let CombatRelatedSpecialAbility;
+        (function (CombatRelatedSpecialAbility) {
+            CombatRelatedSpecialAbility["CombatSpecialAbility"] = "CombatSpecialAbility";
+            CombatRelatedSpecialAbility["CombatStyleSpecialAbility"] = "CombatStyleSpecialAbility";
+            CombatRelatedSpecialAbility["AdvancedCombatSpecialAbility"] = "AdvancedCombatSpecialAbility";
+            CombatRelatedSpecialAbility["CommandSpecialAbility"] = "CommandSpecialAbility";
+        })(CombatRelatedSpecialAbility = Tag.CombatRelatedSpecialAbility || (Tag.CombatRelatedSpecialAbility = {}));
         let Rated;
         (function (Rated) {
             Rated["Attribute"] = "Attribute";

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

@@ -13,6 +13,7 @@ export declare type AdvancedCombatSpecialAbility = {
     usage_type: Activatable.CombatSpecialAbilityType;
     skill_applications?: Activatable.SkillApplications;
     skill_uses?: Activatable.SkillUses;
+    penalty?: Activatable.Penalty;
     combat_techniques: Activatable.ApplicableCombatTechniques;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;

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

@@ -13,6 +13,7 @@ export declare type CombatSpecialAbility = {
     usage_type: Activatable.CombatSpecialAbilityType;
     skill_applications?: Activatable.SkillApplications;
     skill_uses?: Activatable.SkillUses;
+    penalty?: Activatable.Penalty;
     combat_techniques: Activatable.ApplicableCombatTechniques;
     ap_value: Activatable.AdventurePointsValue;
     src: PublicationRefs;

package/lib/types/specialAbility/sub/TradeSecret.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @main TradeSecret
+ */
+import { Errata } from "../../source/_Erratum";
+import { PublicationRefs } from "../../source/_PublicationRef";
+/**
+ * @title Trade Secret
+ */
+export declare type TradeSecret = {
+    /**
+     * The trade secret's identifier. An unique, increasing integer.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * The adventure points value of the trade secret.
+     * @integer
+     * @minimum 1
+     */
+    ap_value: number;
+    /**
+     * Is this trade secret considered secret knowledge?
+     */
+    is_secret_knowledge: boolean;
+    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 trade secret.
+             * @minLength 1
+             */
+            name: string;
+            /**
+             * The description of the trade secret.
+             * @markdown
+             * @minLength 1
+             */
+            description?: string;
+            errata?: Errata;
+        };
+    };
+};

package/lib/types/specialAbility/sub/TradeSecret.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Definitions and utilities for the flat-file database of Optolith, a character creation tool for the Pen and Paper RPG “The Dark Eye 5”, and its external integrations into other software.",
   "keywords": [
     "tde",
@@ -25,7 +25,7 @@
   },
   "devDependencies": {
     "@types/node": "^17.0.21",
-    "optolith-tsjsonschemamd": "^0.5.2",
+    "optolith-tsjsonschemamd": "^0.5.3",
     "standard-version": "^9.3.2",
     "typescript": "^4.6.2"
   },