optolith-database-schema 0.2.4 → 0.4.1

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

@@ -0,0 +1,369 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/Poison.schema.json",
+  "$ref": "#/$defs/Poison",
+  "$defs": {
+    "Poison": {
+      "title": "Poison",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The poison's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "level": {
+          "description": "The poison's level.",
+          "$ref": "#/$defs/PoisonLevel"
+        },
+        "application_type": {
+          "description": "The poison's application type(s).",
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/PoisonApplicationType"
+          },
+          "minItems": 1,
+          "uniqueItems": true
+        },
+        "source_type": {
+          "description": "The poison's source type and dependent additional values.",
+          "$ref": "#/$defs/PoisonSourceType"
+        },
+        "resistance": {
+          "description": "Use Spirit or Toughness as a modifier for the poison.",
+          "$ref": "../../_DiseasePoison.schema.json#/$defs/Resistance"
+        },
+        "value": {
+          "description": "The raw (ingredients) value, in silverthalers.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "cost": {
+          "description": "Price for one dose, in silverthalers.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "src": {
+          "$ref": "../../source/_PublicationRef.schema.json#/$defs/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/PoisonTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "level",
+        "application_type",
+        "source_type",
+        "resistance",
+        "value",
+        "cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "PoisonLevel": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "QualityLevel"
+            },
+            "quality_level": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "quality_level"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Fixed"
+            },
+            "fixed": {
+              "$ref": "#/$defs/FixedPoisonLevel"
+            }
+          },
+          "required": [
+            "tag",
+            "fixed"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "FixedPoisonLevel": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "value"
+      ],
+      "additionalProperties": false
+    },
+    "PoisonApplicationType": {
+      "enum": [
+        "Weapon",
+        "Ingestion",
+        "Inhalation",
+        "Contact"
+      ]
+    },
+    "PoisonSourceType": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "AnimalVenom"
+            },
+            "animal_venom": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "animal_venom"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "AlchemicalPoison"
+            },
+            "alchemical_poison": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "alchemical_poison"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "MineralPoison"
+            },
+            "mineral_poison": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "mineral_poison"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "PlantPoison"
+            },
+            "plant_poison": {
+              "$ref": "#/$defs/PlantPoison"
+            }
+          },
+          "required": [
+            "tag",
+            "plant_poison"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "PlantPoison": {
+      "type": "object",
+      "properties": {
+        "category": {
+          "description": "The plant poison category and dependent additional values.",
+          "$ref": "#/$defs/PlantPoisonCategory"
+        }
+      },
+      "required": [
+        "category"
+      ],
+      "additionalProperties": false
+    },
+    "PlantPoisonCategory": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Default"
+            },
+            "default": {
+              "type": "object",
+              "properties": {},
+              "required": [],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "tag",
+            "default"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Intoxicant"
+            },
+            "intoxicant": {
+              "$ref": "#/$defs/Intoxicant"
+            }
+          },
+          "required": [
+            "tag",
+            "intoxicant"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "Intoxicant": {
+      "type": "object",
+      "properties": {
+        "legality": {
+          "description": "Whether the use of the intoxicant is legal or not.",
+          "$ref": "#/$defs/IntoxicantLegality"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/IntoxicantTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "legality",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "IntoxicantLegality": {
+      "type": "object",
+      "properties": {
+        "is_legal": {
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "is_legal"
+      ],
+      "additionalProperties": false
+    },
+    "IntoxicantTranslation": {
+      "type": "object",
+      "properties": {
+        "ingestion": {
+          "description": "How to ingest the intoxicant.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "side_effect": {
+          "description": "The intoxicants side effects, if any.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "overdose": {
+          "description": "What happens if the intoxicant has been overdosed.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "special": {
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "addiction": {
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        }
+      },
+      "required": [
+        "ingestion",
+        "overdose"
+      ],
+      "additionalProperties": false
+    },
+    "PoisonTranslation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The name of the poison.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "alternative_names": {
+          "description": "A list of alternative names.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_AlternativeNames.schema.json#/$defs/AlternativeName"
+          },
+          "minItems": 1
+        },
+        "effect": {
+          "description": "The normal and degraded poison's effects.",
+          "$ref": "../../_DiseasePoison.schema.json#/$defs/Reduceable"
+        },
+        "start": {
+          "description": "When the poison takes effect.",
+          "type": "string",
+          "minLength": 1
+        },
+        "duration": {
+          "description": "The normal and degraded poison's duration.",
+          "$ref": "../../_DiseasePoison.schema.json#/$defs/Reduceable"
+        },
+        "errata": {
+          "$ref": "../../source/_Erratum.schema.json#/$defs/Errata"
+        }
+      },
+      "required": [
+        "name",
+        "effect",
+        "start",
+        "duration"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/RopeOrChain.schema.json

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

package/schema/equipment/item/Stationary.schema.json

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

package/schema/equipment/item/ThievesTool.schema.json

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

package/schema/equipment/item/ToolOfTheTrade.schema.json

@@ -0,0 +1,82 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/ToolOfTheTrade.schema.json",
+  "$ref": "#/$defs/ToolOfTheTrade",
+  "$defs": {
+    "ToolOfTheTrade": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers.",
+          "$ref": "./_Item.schema.json#/$defs/Cost"
+        },
+        "weight": {
+          "description": "The weight in kg.",
+          "$ref": "./_Item.schema.json#/$defs/Weight"
+        },
+        "complexity": {
+          "description": "The complexity of crafting the item.",
+          "$ref": "./_Item.schema.json#/$defs/Complexity"
+        },
+        "structure_points": {
+          "description": "The structure points of the item. Use an array if the item consists of\nmultiple components that have individual structure points.",
+          "$ref": "./_Item.schema.json#/$defs/StructurePoints"
+        },
+        "is_laboratory": {
+          "description": "If the item is a laboratory.",
+          "type": "boolean"
+        },
+        "src": {
+          "$ref": "../../source/_PublicationRef.schema.json#/$defs/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "#/$defs/ToolOfTheTradeTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "weight",
+        "is_laboratory",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "ToolOfTheTradeTranslation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "description": "The name of the item.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "secondary_name": {
+          "description": "An auxiliary name or label of the item, if available.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyString"
+        },
+        "note": {
+          "description": "Note text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "rules": {
+          "description": "Special rules text.",
+          "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
+        },
+        "errata": {
+          "$ref": "../../source/_Erratum.schema.json#/$defs/Errata"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/equipment/item/TravelGearOrTool.schema.json

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

package/schema/equipment/item/Vehicle.schema.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/equipment/item/Vehicle.schema.json",
+  "$ref": "#/$defs/Vehicle",
+  "$defs": {
+    "Vehicle": {
+      "type": "object",
+      "properties": {
+        "cost": {
+          "description": "The cost in silverthalers.",
+          "$ref": "./_Item.schema.json#/$defs/Cost"
+        },
+        "src": {
+          "$ref": "../../source/_PublicationRef.schema.json#/$defs/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "$ref": "./_Item.schema.json#/$defs/DefaultItemTranslation"
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}