optolith-database-schema 0.0.1

package/lib/types/source/_PublicationRef.d.ts

@@ -0,0 +1,146 @@
+/**
+ * @main PublicationRefs
+ */
+/**
+ * The publications where you can find the entry.
+ * @title Publication References
+ * @minItems 1
+ */
+export declare type PublicationRefs = PublicationRef[];
+/**
+ * A source reference. It contains the book's publisher identifier and the page
+ * where it occurs. If an entry spans multiple pages, provide the last page as
+ * well.
+ * @title Publication Reference
+ */
+export declare type PublicationRef = {
+    /**
+     * The publication's identifier.
+     * @integer
+     * @minimum 1
+     */
+    id: number;
+    /**
+     * All occurrences of the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    occurrences: {
+        /**
+         * @patternProperties ^[a-z]{2}-[A-Z]{2}$
+         */
+        [localeId: string]: Occurrence;
+    };
+};
+declare type Occurrence = SimpleOccurrence | SimpleOccurrences | VersionedOccurrence;
+/**
+ * @title Simple Occurrences
+ * @minItems 1
+ */
+declare type SimpleOccurrences = SimpleOccurrence[];
+/**
+ * @title Simple Occurrence
+ */
+declare type SimpleOccurrence = {
+    /**
+     * The page where it occurs. If the entry spans multiple pages, use this as
+     * the first page and `last_page` as the last page.
+     * @integer
+     * @minimum 1
+     */
+    first_page: number;
+    /**
+     * The last page where it occurs. If there is only one page, set this to the
+     * same as `first_page` oder remove it.
+     * @integer
+     * @minimum 2
+     */
+    last_page?: number;
+};
+/**
+ * @title Versioned Occurrence
+ */
+declare type VersionedOccurrence = {
+    /**
+     * The initial occurrence of the entry.
+     * @title Initial
+     */
+    initial: {
+        /**
+         * The publication's printing since which the entry is present. Leave
+         * empty if present since the beginning.
+         * @integer
+         * @minimum 2
+         */
+        printing?: number;
+        /**
+         * The initial page references.
+         * @minItems 1
+         */
+        pages: PageRange[];
+    };
+    /**
+     * Revisions of the entry, resulting in either changed page references or
+     * re-addition or removal of an entry.
+     * @minItems 1
+     */
+    revisions?: Revision[];
+};
+/**
+ * A revision of the entry, resulting in either changed page references or
+ * re-addition or removal of an entry.
+ * @title Revision
+ */
+declare type Revision = {
+    tag: "Since";
+    /**
+     * The publication's printing since which the entry is present again or has
+     * changed page references.
+     * @integer
+     * @minimum 2
+     */
+    printing: number;
+    /**
+     * The changed or new page references.
+     * @minItems 1
+     */
+    pages: PageRange[];
+} | {
+    tag: "Deprecated";
+    /**
+     * The publication's printing since which the entry has been removed.
+     * @integer
+     * @minimum 2
+     */
+    printing: number;
+};
+/**
+ * @title Page Range
+ */
+declare type PageRange = {
+    /**
+     * The page where it occurs. If the entry spans multiple pages, use this as
+     * the first page and `last_page` as the last page.
+     */
+    first_page: Page;
+    /**
+     * The last page where it occurs. If there is only one page, set this to the
+     * same as `first_page` oder remove it.
+     */
+    last_page?: Page;
+};
+/**
+ * @title Page
+ */
+declare type Page = {
+    tag: "InsideCoverFront";
+} | {
+    tag: "InsideCoverBack";
+} | {
+    tag: "Numbered";
+    /**
+     * The page number.
+     * @integer
+     */
+    number: number;
+};
+export {};

package/lib/types/source/_PublicationRef.js

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

package/lib/validation/integrity.d.ts

@@ -0,0 +1,16 @@
+export interface ReferencialIntegrityValidators {
+    checkLocaleId: (localeId: string) => boolean;
+}
+export declare const getReferencialIntegrityErrors: <T extends string | number>(ids: T[], check: (id: T) => boolean) => T[];
+export declare const getReferencialIntegrityErrorsWith: <T, U extends string | number>(elements: T[], transform: (element: T) => U, check: (id: U) => boolean) => T[];
+interface Translatable<T> {
+    /**
+     * All translations for the entry, identified by IETF language tag (BCP47).
+     * @minProperties 1
+     */
+    translations: {
+        [localeId: string]: T;
+    };
+}
+export declare const getReferencialIntegrityErrorsForTranslatable: <T>(translatable: Translatable<T>, checkLocaleId: (id: string) => boolean) => string[];
+export {};

package/lib/validation/integrity.js

@@ -0,0 +1,3 @@
+export const getReferencialIntegrityErrors = (ids, check) => ids.filter(id => !check(id));
+export const getReferencialIntegrityErrorsWith = (elements, transform, check) => elements.filter(element => !check(transform(element)));
+export const getReferencialIntegrityErrorsForTranslatable = (translatable, checkLocaleId) => getReferencialIntegrityErrors(Object.keys(translatable.translations), checkLocaleId);

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "optolith-database-schema",
+  "version": "0.0.1",
+  "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",
+    "thedarkeye",
+    "dsa",
+    "dasschwarzeauge"
+  ],
+  "main": "./lib/main.js",
+  "types": "./lib/main.d.ts",
+  "scripts": {
+    "build:ts": "tsc",
+    "build:gen": "node ./build/generate.js",
+    "build": "npm run build:ts && npm run build:gen",
+    "release": "standard-version",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Lukas Obermann",
+  "license": "MPL-2.0",
+  "dependencies": {
+    "ajv": "^8.10.0",
+    "yaml": "^1.10.2"
+  },
+  "devDependencies": {
+    "@types/node": "^17.0.21",
+    "optolith-tsjsonschemamd": "^0.5.1",
+    "standard-version": "^9.3.2",
+    "typescript": "^4.6.2"
+  },
+  "repository": "github:elyukai/optolith-database-schema",
+  "bugs": {
+    "url": "https://github.com/elyukai/optolith-database-schema/issues"
+  },
+  "type": "module"
+}

package/schema/ArcaneBardTradition.schema.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "ArcaneBardTradition.schema.json",
+  "$ref": "#/definitions/ArcaneBardTradition",
+  "definitions": {
+    "ArcaneBardTradition": {
+      "title": "Arcane Bard Tradition",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The arcane bard tradition's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "prerequisites": {
+          "$ref": "./_Prerequisite.schema.json#/definitions/GroupCollection/ArcaneTradition"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The arcane bard tradition's name.",
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "prerequisites",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/ArcaneDancerTradition.schema.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "ArcaneDancerTradition.schema.json",
+  "$ref": "#/definitions/ArcaneDancerTradition",
+  "definitions": {
+    "ArcaneDancerTradition": {
+      "title": "Arcane Dancer Tradition",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The arcane dancer tradition's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "prerequisites": {
+          "$ref": "./_Prerequisite.schema.json#/definitions/GroupCollection/ArcaneTradition"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The arcane dancer tradition's name.",
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "prerequisites",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/Aspect.schema.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "Aspect.schema.json",
+  "$ref": "#/definitions/Aspect",
+  "definitions": {
+    "Aspect": {
+      "title": "Aspect",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The aspect's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The aspect name.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "master_of_aspect_suffix": {
+                  "description": "The aspect's name appended to the simple name (not `name_in_library`)\nof the special ability *Master of (Aspect)*.",
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/Attribute.schema.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "Attribute.schema.json",
+  "$ref": "#/definitions/Attribute",
+  "definitions": {
+    "Attribute": {
+      "title": "Attribute",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The attribute's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The attribute's name.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "abbreviation": {
+                  "description": "The abbreviation of the attribute's name.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "description": {
+                  "description": "The description of the attribute.",
+                  "type": "string",
+                  "minLength": 1
+                }
+              },
+              "required": [
+                "name",
+                "abbreviation",
+                "description"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "translations"
+      ],
+      "additionalProperties": false
+    }
+  }
+}

package/schema/CombatTechnique_Close.schema.json

@@ -0,0 +1,127 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "CombatTechnique_Close.schema.json",
+  "$ref": "#/definitions/CloseCombatTechnique",
+  "definitions": {
+    "CloseCombatTechnique": {
+      "title": "Close Combat Technique",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The close combat technique's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "special": {
+          "description": "Special rules for the combat technique that apply to all weapons in this\ncategory.",
+          "type": "object",
+          "properties": {
+            "parrying": {
+              "description": "Is parrying possible with this combat technique?",
+              "$ref": "#/definitions/Parrying"
+            }
+          },
+          "required": [
+            "parrying"
+          ],
+          "additionalProperties": false
+        },
+        "primary_attribute": {
+          "description": "The primary attribute(s).",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PrimaryAttribute"
+          },
+          "minItems": 1,
+          "maxItems": 2,
+          "uniqueItems": true
+        },
+        "breaking_point_rating": {
+          "description": "The *Breaking Point Rating* of the respective combat technique.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "improvement_cost": {
+          "$ref": "./_ImprovementCost.schema.json#/definitions/ImprovementCost"
+        },
+        "src": {
+          "$ref": "./source/_PublicationRef.schema.json#/definitions/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The name of the condition.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "special": {
+                  "description": "Additional rules for the condition, if applicable.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "errata": {
+                  "$ref": "./source/_Erratum.schema.json#/definitions/Errata"
+                }
+              },
+              "required": [
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "special",
+        "primary_attribute",
+        "breaking_point_rating",
+        "improvement_cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "Parrying": {
+      "description": "Is parrying possible with this combat technique?",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Possible"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "tag": {
+              "const": "Impossible"
+            }
+          },
+          "required": [
+            "tag"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "PrimaryAttribute": {
+      "description": "The attribute's identifier.",
+      "type": "integer",
+      "minimum": 1
+    }
+  }
+}

package/schema/CombatTechnique_Ranged.schema.json

@@ -0,0 +1,83 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "CombatTechnique_Ranged.schema.json",
+  "$ref": "#/definitions/RangedCombatTechnique",
+  "definitions": {
+    "RangedCombatTechnique": {
+      "title": "Ranged Combat Technique",
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "The ranged combat technique's identifier. An unique, increasing integer.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "primary_attribute": {
+          "description": "The primary attribute(s).",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/PrimaryAttribute"
+          },
+          "minItems": 1,
+          "maxItems": 2,
+          "uniqueItems": true
+        },
+        "breaking_point_rating": {
+          "description": "The *Breaking Point Rating* of the respective combat technique.",
+          "type": "integer",
+          "minimum": 1
+        },
+        "improvement_cost": {
+          "$ref": "./_ImprovementCost.schema.json#/definitions/ImprovementCost"
+        },
+        "src": {
+          "$ref": "./source/_PublicationRef.schema.json#/definitions/PublicationRefs"
+        },
+        "translations": {
+          "description": "All translations for the entry, identified by IETF language tag (BCP47).",
+          "type": "object",
+          "patternProperties": {
+            "^[a-z]{2}-[A-Z]{2}$": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "description": "The name of the condition.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "special": {
+                  "description": "Additional rules for the condition, if applicable.",
+                  "type": "string",
+                  "minLength": 1
+                },
+                "errata": {
+                  "$ref": "./source/_Erratum.schema.json#/definitions/Errata"
+                }
+              },
+              "required": [
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "minProperties": 1,
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "primary_attribute",
+        "breaking_point_rating",
+        "improvement_cost",
+        "src",
+        "translations"
+      ],
+      "additionalProperties": false
+    },
+    "PrimaryAttribute": {
+      "description": "The attribute's identifier.",
+      "type": "integer",
+      "minimum": 1
+    }
+  }
+}