optolith-database-schema 0.9.0 → 0.10.1

package/schema/prerequisites/single/AncestorBloodPrerequisite.schema.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/prerequisites/single/AncestorBloodPrerequisite.schema.json",
+  "$defs": {
+    "AncestorBloodPrerequisite": {
+      "title": "Ancestor Blood Prerequisite",
+      "description": "Requires that no other Ancestor Blood advantage is active.",
+      "type": "object",
+      "properties": {},
+      "required": [],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/RatedMinimumNumberPrerequisite.schema.json

@@ -0,0 +1,166 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/prerequisites/single/RatedMinimumNumberPrerequisite.schema.json",
+  "$defs": {
+    "RatedMinimumNumberPrerequisite": {
+      "title": "Rated Minimum Number Prerequisite",
+      "type": "object",
+      "properties": {
+        "number": {
+          "description": "The minimum number of skills that need to be on the defined minimum skill\nrating.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "value": {
+          "description": "The minimum skill rating the defined minimum number of skills need to be\non.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "targets": {
+          "description": "The targets that contribute to satisfying the prerequisite.",
+          "$ref": "#/$defs/RatedMinimumNumberPrerequisiteTarget"
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/$defs/DisplayOption"
+        }
+      },
+      "required": [
+        "number",
+        "value",
+        "targets"
+      ],
+      "additionalProperties": false
+    },
+    "RatedMinimumNumberPrerequisiteTarget": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Skills"
+            },
+            "skills": {
+              "$ref": "#/$defs/RatedMinimumNumberPrerequisiteSkillsTarget"
+            }
+          },
+          "required": [
+            "tag",
+            "skills"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "CombatTechniques"
+            },
+            "combat_techniques": {
+              "$ref": "#/$defs/CombatTechniquesTarget"
+            }
+          },
+          "required": [
+            "tag",
+            "combat_techniques"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Spellworks"
+            },
+            "spellworks": {
+              "$ref": "../../_SimpleReferences.schema.json#/$defs/PropertyReference"
+            }
+          },
+          "required": [
+            "tag",
+            "spellworks"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Liturgies"
+            },
+            "liturgies": {
+              "$ref": "../../_SimpleReferences.schema.json#/$defs/AspectReference"
+            }
+          },
+          "required": [
+            "tag",
+            "liturgies"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "RatedMinimumNumberPrerequisiteSkillsTarget": {
+      "type": "object",
+      "properties": {
+        "list": {
+          "description": "The skills that are taken into account for satisfying the prerequisite.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_SimpleReferences.schema.json#/$defs/SkillReference"
+          },
+          "minItems": 2,
+          "uniqueItems": true
+        }
+      },
+      "required": [
+        "list"
+      ],
+      "additionalProperties": false
+    },
+    "CombatTechniquesTarget": {
+      "type": "object",
+      "properties": {
+        "group": {
+          "$ref": "#/$defs/CombatTechniquesTargetGroup"
+        }
+      },
+      "required": [
+        "group"
+      ],
+      "additionalProperties": false
+    },
+    "CombatTechniquesTargetGroup": {
+      "enum": [
+        "All",
+        "Close",
+        "Ranged"
+      ]
+    },
+    "RatedMinimumNumberPrerequisiteSpellworksTarget": {
+      "type": "object",
+      "properties": {
+        "property": {
+          "description": "The skills that are taken into account for satisfying the prerequisite.",
+          "$ref": "../../_SimpleReferences.schema.json#/$defs/PropertyReference"
+        }
+      },
+      "required": [
+        "property"
+      ],
+      "additionalProperties": false
+    },
+    "RatedMinimumNumberPrerequisiteLiturgiesTarget": {
+      "type": "object",
+      "properties": {
+        "aspect": {
+          "description": "The skills that are taken into account for satisfying the prerequisite.",
+          "$ref": "../../_SimpleReferences.schema.json#/$defs/AspectReference"
+        }
+      },
+      "required": [
+        "aspect"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/RatedPrerequisite.schema.json

@@ -24,131 +24,6 @@
         "value"
       ],
       "additionalProperties": false
-    },
-    "RatedMinimumNumberPrerequisite": {
-      "title": "Rated Minimum Number Prerequisite",
-      "type": "object",
-      "properties": {
-        "number": {
-          "description": "The minimum number of skills that need to be on the defined minimum skill\nrating.",
-          "type": "integer",
-          "minimum": 1
-        },
-        "value": {
-          "description": "The minimum skill rating the defined minimum number of skills need to be\non.",
-          "type": "integer",
-          "minimum": 1
-        },
-        "targets": {
-          "description": "The targets that contribute to satisfying the prerequisite.",
-          "$ref": "#/$defs/RatedMinimumNumberPrerequisiteTarget"
-        },
-        "display_option": {
-          "$ref": "../DisplayOption.schema.json#/$defs/DisplayOption"
-        }
-      },
-      "required": [
-        "number",
-        "value",
-        "targets"
-      ],
-      "additionalProperties": false
-    },
-    "RatedMinimumNumberPrerequisiteTarget": {
-      "oneOf": [
-        {
-          "type": "object",
-          "properties": {
-            "tag": {
-              "const": "Skills"
-            },
-            "skills": {
-              "$ref": "#/$defs/RatedMinimumNumberPrerequisiteSkillsTarget"
-            }
-          },
-          "required": [
-            "tag",
-            "skills"
-          ],
-          "additionalProperties": false
-        },
-        {
-          "type": "object",
-          "properties": {
-            "tag": {
-              "const": "Spellworks"
-            },
-            "spellworks": {
-              "$ref": "../../_SimpleReferences.schema.json#/$defs/PropertyReference"
-            }
-          },
-          "required": [
-            "tag",
-            "spellworks"
-          ],
-          "additionalProperties": false
-        },
-        {
-          "type": "object",
-          "properties": {
-            "tag": {
-              "const": "Liturgies"
-            },
-            "liturgies": {
-              "$ref": "../../_SimpleReferences.schema.json#/$defs/AspectReference"
-            }
-          },
-          "required": [
-            "tag",
-            "liturgies"
-          ],
-          "additionalProperties": false
-        }
-      ]
-    },
-    "RatedMinimumNumberPrerequisiteSkillsTarget": {
-      "type": "object",
-      "properties": {
-        "list": {
-          "description": "The skills that are taken into account for satisfying the prerequisite.",
-          "type": "array",
-          "items": {
-            "$ref": "../../_SimpleReferences.schema.json#/$defs/SkillReference"
-          },
-          "minItems": 2,
-          "uniqueItems": true
-        }
-      },
-      "required": [
-        "list"
-      ],
-      "additionalProperties": false
-    },
-    "RatedMinimumNumberPrerequisiteSpellworksTarget": {
-      "type": "object",
-      "properties": {
-        "property": {
-          "description": "The skills that are taken into account for satisfying the prerequisite.",
-          "$ref": "../../_SimpleReferences.schema.json#/$defs/PropertyReference"
-        }
-      },
-      "required": [
-        "property"
-      ],
-      "additionalProperties": false
-    },
-    "RatedMinimumNumberPrerequisiteLiturgiesTarget": {
-      "type": "object",
-      "properties": {
-        "aspect": {
-          "description": "The skills that are taken into account for satisfying the prerequisite.",
-          "$ref": "../../_SimpleReferences.schema.json#/$defs/AspectReference"
-        }
-      },
-      "required": [
-        "aspect"
-      ],
-      "additionalProperties": false
     }
   }
 }

package/schema/prerequisites/single/RatedSumPrerequisite.schema.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/prerequisites/single/RatedSumPrerequisite.schema.json",
+  "$defs": {
+    "RatedSumPrerequisite": {
+      "title": "Rated Sum Prerequisite",
+      "type": "object",
+      "properties": {
+        "sum": {
+          "description": "The minimum required sum of the targets’ ratings.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "targets": {
+          "description": "The targets that are included in calculating the sum.",
+          "type": "array",
+          "items": {
+            "$ref": "../../_IdentifierGroup.schema.json#/$defs/SkillIdentifier"
+          },
+          "minItems": 2
+        },
+        "display_option": {
+          "$ref": "../DisplayOption.schema.json#/$defs/DisplayOption"
+        }
+      },
+      "required": [
+        "sum",
+        "targets"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/prerequisites/single/SexualCharacteristicPrerequisite.schema.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json-schema.org/draft/2019-09/schema",
+  "$id": "/prerequisites/single/SexualCharacteristicPrerequisite.schema.json",
+  "$defs": {
+    "SexualCharacteristicPrerequisite": {
+      "title": "Sexual Characteristic Prerequisite",
+      "description": "Requires a specific sexual characteristic.",
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/SexualCharacteristic"
+        }
+      },
+      "required": [
+        "id"
+      ],
+      "additionalProperties": false
+    },
+    "SexualCharacteristic": {
+      "enum": [
+        "Penis",
+        "Vagina"
+      ]
+    }
+  }
+}

package/schema/prerequisites/single/TextPrerequisite.schema.json

@@ -11,6 +11,14 @@
           "description": "The method how the prerequisite should be verified. Either is passes all\nverification text or it denies all verification tests. The latter results\nin the associated entry to never be available for purchase.",
           "$ref": "#/$defs/TextVerificationRule"
         },
+        "sentence_type": {
+          "description": "If the text is a sentence or sentence-like fragment, this property ensures\nit is integrated into the prerequisite string correctly.\n\nA standalone sentence is connected to the previous prerequisite string with\na period and a period is also added at the end of the sentence\nautomatically, if it is not present. A connected sentence is connected to\nthe previous prerequisite string with a semicolon and a period is not added\nto the end of the sentence. In this case, if there are prerequisites after\nthis one, they will be connected using a semicolon again, unless a\ndifferent punctuation mark is present at the end of the given text.",
+          "$ref": "#/$defs/SentenceType"
+        },
+        "is_meta": {
+          "description": "If the text does not represent an actual prerequisite but a prerequisite\nfor the use of certain aspects or the entry the prerequisite is associated\nwith, or something like that, this property is set to `true`.\n\nIf all prerequisites of an entry are marked as meta, the entry is\nconsidered to have no prerequisites and thus the string `none` must be\nrendered before the list of meta prerequisites.\n\nThis is the only use case for this property.",
+          "const": true
+        },
         "translations": {
           "description": "All translations for the entry, identified by IETF language tag (BCP47).",
           "type": "object",
@@ -35,6 +43,12 @@
         "Deny"
       ]
     },
+    "SentenceType": {
+      "enum": [
+        "Standalone",
+        "Connected"
+      ]
+    },
     "TextPrerequisiteTranslation": {
       "$ref": "../../_NonEmptyString.schema.json#/$defs/NonEmptyMarkdown"
     }

package/schema/specialAbility/AdvancedCombatSpecialAbility.schema.json

@@ -80,6 +80,14 @@
         "penalty": {
           "type": "string"
         },
+        "ap_value": {
+          "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement"
+        },
+        "ap_value_append": {
+          "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text\nis replaced.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueAppend"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/specialAbility/CeremonialItemSpecialAbility.schema.json

@@ -69,6 +69,10 @@
         "effect": {
           "$ref": "../_Activatable.schema.json#/$defs/Effect"
         },
+        "prerequisites": {
+          "description": "The prerequisites text. It is only used if the text cannot be generated\nfrom the given information.",
+          "$ref": "../_Activatable.schema.json#/$defs/PrerequisitesReplacement"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/specialAbility/CombatSpecialAbility.schema.json

@@ -74,6 +74,10 @@
         "name_in_library": {
           "$ref": "../_Activatable.schema.json#/$defs/NameInLibrary"
         },
+        "input": {
+          "description": "A string that is used as a label for an input field.",
+          "$ref": "../_Activatable.schema.json#/$defs/Input"
+        },
         "rules": {
           "$ref": "../_Activatable.schema.json#/$defs/Rules"
         },

package/schema/specialAbility/FatePointSpecialAbility.schema.json

@@ -66,6 +66,10 @@
         "rules": {
           "$ref": "../_Activatable.schema.json#/$defs/Rules"
         },
+        "ap_value": {
+          "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/specialAbility/GeneralSpecialAbility.schema.json

@@ -63,9 +63,17 @@
         "name_in_library": {
           "$ref": "../_Activatable.schema.json#/$defs/NameInLibrary"
         },
+        "input": {
+          "description": "A string that is used as a label for an input field.",
+          "$ref": "../_Activatable.schema.json#/$defs/Input"
+        },
         "rules": {
           "$ref": "../_Activatable.schema.json#/$defs/Rules"
         },
+        "ap_value_append": {
+          "description": "A string that gets appended to the default AP Value text with a preceding\nspace. This always happens if present, even if the generated AP Value text\nis replaced.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueAppend"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/specialAbility/KarmaSpecialAbility.schema.json

@@ -60,6 +60,10 @@
         "rules": {
           "$ref": "../_Activatable.schema.json#/$defs/Rules"
         },
+        "ap_value": {
+          "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/specialAbility/MagicalSpecialAbility.schema.json

@@ -63,9 +63,17 @@
         "name_in_library": {
           "$ref": "../_Activatable.schema.json#/$defs/NameInLibrary"
         },
+        "input": {
+          "description": "A string that is used as a label for an input field.",
+          "$ref": "../_Activatable.schema.json#/$defs/Input"
+        },
         "rules": {
           "$ref": "../_Activatable.schema.json#/$defs/Rules"
         },
+        "ap_value": {
+          "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/specialAbility/SikaryanDrainSpecialAbility.schema.json

@@ -60,6 +60,10 @@
         "rules": {
           "$ref": "../_Activatable.schema.json#/$defs/Rules"
         },
+        "ap_value": {
+          "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/specialAbility/VampiricGift.schema.json

@@ -60,6 +60,10 @@
         "rules": {
           "$ref": "../_Activatable.schema.json#/$defs/Rules"
         },
+        "ap_value": {
+          "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/traditionArtifacts/SpellSwordEnchantment.schema.json

@@ -80,6 +80,10 @@
         "bindingCost": {
           "type": "string"
         },
+        "ap_value": {
+          "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }

package/schema/traditionArtifacts/StaffEnchantment.schema.json

@@ -77,9 +77,17 @@
         "aeCost": {
           "type": "string"
         },
+        "cost_note": {
+          "description": "A note, appended to the generated cost string in parenthesis.",
+          "$ref": "../_ResponsiveText.schema.json#/$defs/ResponsiveTextOptional"
+        },
         "bindingCost": {
           "type": "string"
         },
+        "ap_value": {
+          "description": "The AP value. It is only used if the text cannot be generated from the\ngiven information.",
+          "$ref": "../_Activatable.schema.json#/$defs/AdventurePointsValueReplacement"
+        },
         "errata": {
           "$ref": "../source/_Erratum.schema.json#/$defs/Errata"
         }