optolith-database-schema 0.13.8 → 0.14.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 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.14.0](https://github.com/elyukai/optolith-database-schema/compare/v0.13.8...v0.14.0) (2023-12-27)
+
+
+### ⚠ BREAKING CHANGES
+
+* remove equipment category Alchemicum
+
+### Features
+
+* add optional "notes" field to poison translation ([0cf9d98](https://github.com/elyukai/optolith-database-schema/commit/0cf9d988907734b89119cf6d9e3a3d480199128f)), closes [#28](https://github.com/elyukai/optolith-database-schema/issues/28)
+* add poison duration type "instant" ([0581049](https://github.com/elyukai/optolith-database-schema/commit/0581049f282988ca5a24ff4ba219310003061d59))
+
+
+### Bug Fixes
+
+* add elixir identifier ([98993f7](https://github.com/elyukai/optolith-database-schema/commit/98993f7c351fc647cbe6982276cebab0e014ec44))
+* remove equipment category Alchemicum ([95768f3](https://github.com/elyukai/optolith-database-schema/commit/95768f30131b9c4e3f66f01950b6c7ea6f9ccfff)), closes [#32](https://github.com/elyukai/optolith-database-schema/issues/32)
+* weapons should require a complexity ([7ad54e1](https://github.com/elyukai/optolith-database-schema/commit/7ad54e1c16e8782072d543450a27a5572ab875ed))
+
 ### [0.13.8](https://github.com/elyukai/optolith-database-schema/compare/v0.13.7...v0.13.8) (2023-12-07)
 
 ### [0.13.7](https://github.com/elyukai/optolith-database-schema/compare/v0.13.6...v0.13.7) (2023-12-05)

package/lib/config/types.d.ts

@@ -48,7 +48,6 @@ import * as Talisman from "../types/Talisman.js";
 import * as TargetCategory from "../types/TargetCategory.js";
 import * as UI from "../types/UI.js";
 import * as EquipmentPackage from "../types/equipment/EquipmentPackage.js";
-import * as Alchemicum from "../types/equipment/item/Alchemicum.js";
 import * as Ammunition from "../types/equipment/item/Ammunition.js";
 import * as Animal from "../types/equipment/item/Animal.js";
 import * as AnimalCare from "../types/equipment/item/AnimalCare.js";
@@ -157,7 +156,6 @@ export type TypeMap = {
     advancedMagicalSpecialAbilities: AdvancedMagicalSpecialAbility.AdvancedMagicalSpecialAbility;
     advancedSkillSpecialAbilities: AdvancedSkillSpecialAbility.AdvancedSkillSpecialAbility;
     advantages: Advantage.Advantage;
-    alchemicae: Alchemicum.Alchemicum;
     ammunition: Ammunition.Ammunition;
     ancestorGlyphs: AncestorGlyph.AncestorGlyph;
     animalCare: AnimalCare.AnimalCare;
@@ -312,7 +310,6 @@ export declare const configMap: {
     advancedMagicalSpecialAbilities: import("../typeConfig.js").TypeConfig<AdvancedMagicalSpecialAbility.AdvancedMagicalSpecialAbility>;
     advancedSkillSpecialAbilities: import("../typeConfig.js").TypeConfig<AdvancedSkillSpecialAbility.AdvancedSkillSpecialAbility>;
     advantages: import("../typeConfig.js").TypeConfig<Advantage.Advantage>;
-    alchemicae: import("../typeConfig.js").TypeConfig<import("../types/equipment/item/_Item.js").DefaultItem>;
     ammunition: import("../typeConfig.js").TypeConfig<Ammunition.Ammunition>;
     ancestorGlyphs: import("../typeConfig.js").TypeConfig<AncestorGlyph.AncestorGlyph>;
     animalCare: import("../typeConfig.js").TypeConfig<AnimalCare.AnimalCare>;

package/lib/config/types.js

@@ -48,7 +48,6 @@ import * as Talisman from "../types/Talisman.js";
 import * as TargetCategory from "../types/TargetCategory.js";
 import * as UI from "../types/UI.js";
 import * as EquipmentPackage from "../types/equipment/EquipmentPackage.js";
-import * as Alchemicum from "../types/equipment/item/Alchemicum.js";
 import * as Ammunition from "../types/equipment/item/Ammunition.js";
 import * as Animal from "../types/equipment/item/Animal.js";
 import * as AnimalCare from "../types/equipment/item/AnimalCare.js";
@@ -157,7 +156,6 @@ export const configMap = {
     advancedMagicalSpecialAbilities: AdvancedMagicalSpecialAbility.config,
     advancedSkillSpecialAbilities: AdvancedSkillSpecialAbility.config,
     advantages: Advantage.config,
-    alchemicae: Alchemicum.config,
     ammunition: Ammunition.config,
     ancestorGlyphs: AncestorGlyph.config,
     animalCare: AnimalCare.config,

package/lib/types/_Identifier.d.ts

@@ -830,15 +830,6 @@ export type PatronIdentifier = {
      */
     patron: number;
 };
-export type AlchemicumIdentifier = {
-    tag: "Alchemicum";
-    /**
-     * The alchemicum’s identifier.
-     * @integer
-     * @minimum 1
-     */
-    alchemicum: number;
-};
 export type AmmunitionIdentifier = {
     tag: "Ammunition";
     /**
@@ -920,6 +911,15 @@ export type ContainerIdentifier = {
      */
     container: number;
 };
+export type ElixirIdentifier = {
+    tag: "Elixir";
+    /**
+     * The elixir’s identifier.
+     * @integer
+     * @minimum 1
+     */
+    elixir: number;
+};
 export type EquipmentOfBlessedOnesIdentifier = {
     tag: "EquipmentOfBlessedOnes";
     /**

package/lib/types/_IdentifierGroup.d.ts

@@ -15,7 +15,7 @@ export type LiturgyIdentifier = Identifier.LiturgicalChantIdentifier | Identifie
 export type MagicalActionIdentifier = Identifier.CurseIdentifier | Identifier.ElvenMagicalSongIdentifier | Identifier.DominationRitualIdentifier | Identifier.MagicalMelodyIdentifier | Identifier.MagicalDanceIdentifier | Identifier.JesterTrickIdentifier | Identifier.AnimistPowerIdentifier | Identifier.GeodeRitualIdentifier | Identifier.ZibiljaRitualIdentifier;
 export type RequirableSelectOptionIdentifier = Identifier.GeneralIdentifier | Identifier.SkillIdentifier | Identifier.CloseCombatTechniqueIdentifier | Identifier.RangedCombatTechniqueIdentifier;
 export type CoreRuleDerivableContentIdentifier = Identifier.MagicalTraditionIdentifier | Identifier.FamiliarSpecialAbilityIdentifier | Identifier.MagicalSpecialAbilityIdentifier | Identifier.BlessedTraditionIdentifier;
-export type EquipmentIdentifier = Identifier.AlchemicumIdentifier | Identifier.AmmunitionIdentifier | Identifier.AnimalIdentifier | Identifier.AnimalCareIdentifier | Identifier.ArmorIdentifier | Identifier.BandageOrRemedyIdentifier | Identifier.BookIdentifier | Identifier.CeremonialItemIdentifier | Identifier.ClothesIdentifier | Identifier.ContainerIdentifier | Identifier.EquipmentOfBlessedOnesIdentifier | Identifier.GemOrPreciousStoneIdentifier | Identifier.IlluminationLightSourceIdentifier | Identifier.IlluminationRefillsOrSuppliesIdentifier | Identifier.JewelryIdentifier | Identifier.LiebesspielzeugIdentifier | Identifier.LuxuryGoodIdentifier | Identifier.MagicalArtifactIdentifier | Identifier.MusicalInstrumentIdentifier | Identifier.OrienteeringAidIdentifier | Identifier.PoisonIdentifier | Identifier.RopeOrChainIdentifier | Identifier.StationaryIdentifier | Identifier.ThievesToolIdentifier | Identifier.ToolOfTheTradeIdentifier | Identifier.TravelGearOrToolIdentifier | Identifier.VehicleIdentifier | Identifier.WeaponIdentifier | Identifier.WeaponAccessoryIdentifier;
+export type EquipmentIdentifier = Identifier.AmmunitionIdentifier | Identifier.AnimalIdentifier | Identifier.AnimalCareIdentifier | Identifier.ArmorIdentifier | Identifier.BandageOrRemedyIdentifier | Identifier.BookIdentifier | Identifier.CeremonialItemIdentifier | Identifier.ClothesIdentifier | Identifier.ContainerIdentifier | Identifier.ElixirIdentifier | Identifier.EquipmentOfBlessedOnesIdentifier | Identifier.GemOrPreciousStoneIdentifier | Identifier.IlluminationLightSourceIdentifier | Identifier.IlluminationRefillsOrSuppliesIdentifier | Identifier.JewelryIdentifier | Identifier.LiebesspielzeugIdentifier | Identifier.LuxuryGoodIdentifier | Identifier.MagicalArtifactIdentifier | Identifier.MusicalInstrumentIdentifier | Identifier.OrienteeringAidIdentifier | Identifier.PoisonIdentifier | Identifier.RopeOrChainIdentifier | Identifier.StationaryIdentifier | Identifier.ThievesToolIdentifier | Identifier.ToolOfTheTradeIdentifier | Identifier.TravelGearOrToolIdentifier | Identifier.VehicleIdentifier | Identifier.WeaponIdentifier | Identifier.WeaponAccessoryIdentifier;
 export type OneOrManyNumericIdentifiers = OneNumericIdentifier | ManyNumericIdentifiers;
 /**
  * @minimum 1

package/lib/types/equipment/item/Poison.d.ts

@@ -72,6 +72,9 @@ export type PoisonStart = {
     dice_based: DiceBasedPoisonTime;
 };
 export type PoisonDuration = {
+    tag: "Instant";
+    instant: {};
+} | {
     tag: "Constant";
     constant: ConstantPoisonTime;
 } | {
@@ -342,6 +345,10 @@ export type PoisonTranslation = {
      * The normal and degraded poison's effects.
      */
     effect: Reduceable;
+    /**
+     * Notes on the poison's special features.
+     */
+    notes?: NonEmptyString;
     errata?: Errata;
 };
 export declare const config: TypeConfig<Poison>;

package/lib/types/equipment/item/Weapon.d.ts

@@ -20,9 +20,9 @@ export type Weapon = {
      */
     weight: Weight;
     /**
-     * The complexity of crafting the item, if any.
+     * The complexity of crafting the item.
      */
-    complexity?: Complexity;
+    complexity: Complexity;
     /**
      * The structure points of the item. Use an array if the item consists of
      * multiple components that have individual structure points.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optolith-database-schema",
-  "version": "0.13.8",
+  "version": "0.14.0",
   "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",

package/schema/_Identifier.schema.json

@@ -1660,24 +1660,6 @@
       ],
       "additionalProperties": false
     },
-    "AlchemicumIdentifier": {
-      "type": "object",
-      "properties": {
-        "tag": {
-          "const": "Alchemicum"
-        },
-        "alchemicum": {
-          "description": "The alchemicum’s identifier.",
-          "type": "integer",
-          "minimum": 1
-        }
-      },
-      "required": [
-        "tag",
-        "alchemicum"
-      ],
-      "additionalProperties": false
-    },
     "AmmunitionIdentifier": {
       "type": "object",
       "properties": {
@@ -1840,6 +1822,24 @@
       ],
       "additionalProperties": false
     },
+    "ElixirIdentifier": {
+      "type": "object",
+      "properties": {
+        "tag": {
+          "const": "Elixir"
+        },
+        "elixir": {
+          "description": "The elixir’s identifier.",
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "tag",
+        "elixir"
+      ],
+      "additionalProperties": false
+    },
     "EquipmentOfBlessedOnesIdentifier": {
       "type": "object",
       "properties": {

package/schema/_IdentifierGroup.schema.json

@@ -512,9 +512,6 @@
     },
     "EquipmentIdentifier": {
       "oneOf": [
-        {
-          "$ref": "./_Identifier.schema.json#/$defs/AlchemicumIdentifier"
-        },
         {
           "$ref": "./_Identifier.schema.json#/$defs/AmmunitionIdentifier"
         },
@@ -542,6 +539,9 @@
         {
           "$ref": "./_Identifier.schema.json#/$defs/ContainerIdentifier"
         },
+        {
+          "$ref": "./_Identifier.schema.json#/$defs/ElixirIdentifier"
+        },
         {
           "$ref": "./_Identifier.schema.json#/$defs/EquipmentOfBlessedOnesIdentifier"
         },

package/schema/equipment/item/Poison.schema.json

@@ -161,6 +161,25 @@
     },
     "PoisonDuration": {
       "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Instant"
+            },
+            "instant": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "instant"
+          ],
+          "additionalProperties": false
+        },
         {
           "type": "object",
           "properties": {
@@ -790,6 +809,10 @@
           "description": "The normal and degraded poison's effects.",
           "$ref": "../../_DiseasePoison.schema.json#/$defs/Reduceable"
         },
+        "notes": {
+          "description": "Notes on the poison's special features.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
         "errata": {
           "$ref": "../../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/equipment/item/Weapon.schema.json

@@ -15,7 +15,7 @@
           "$ref": "./_Item.schema.json#/$defs/Weight"
         },
         "complexity": {
-          "description": "The complexity of crafting the item, if any.",
+          "description": "The complexity of crafting the item.",
           "$ref": "./_Item.schema.json#/$defs/Complexity"
         },
         "structure_points": {
@@ -64,6 +64,7 @@
       "required": [
         "cost",
         "weight",
+        "complexity",
         "uses",
         "src",
         "translations"

package/lib/types/equipment/item/Alchemicum.d.ts

@@ -1,7 +0,0 @@
-/**
- * @main Alchemicum
- */
-import { TypeConfig } from "../../../typeConfig.js";
-import { DefaultItem } from "./_Item.js";
-export type Alchemicum = DefaultItem;
-export declare const config: TypeConfig<Alchemicum>;

package/lib/types/equipment/item/Alchemicum.js

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

package/schema/equipment/item/Alchemicum.schema.json

@@ -1,10 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2019-09/schema",
-  "$id": "/equipment/item/Alchemicum.schema.json",
-  "$ref": "#/$defs/Alchemicum",
-  "$defs": {
-    "Alchemicum": {
-      "$ref": "./_Item.schema.json#/$defs/DefaultItem"
-    }
-  }
-}