@openpronoun/schema 0.0.0

package/README.md

@@ -0,0 +1,62 @@
+# @openpronoun/schema
+
+The canonical [JSON Schema](https://json-schema.org/) (draft 2020-12) for the
+[OpenPronoun](https://openpronoun.org) data model — `PronounPreference` and
+`PronounSet`. This is the normative model the rest of the ecosystem builds on:
+the runtime library, the conformance fixtures, and any community port all
+validate against this one schema.
+
+## Contents
+
+```
+packages/schema/
+├── package.json
+├── README.md
+└── pronoun-set.schema.json   # PronounPreference / PronounSet (JSON Schema 2020-12)
+```
+
+## Usage
+
+Import the schema as JSON and feed it to any validator (e.g. Ajv):
+
+```js
+import Ajv from "ajv/dist/2020.js";
+import schema from "@openpronoun/schema" with { type: "json" };
+
+const validate = new Ajv({ strict: false }).compile(schema);
+
+validate([{ subjective: "she", objective: "her", possessive_adjective: "her",
+            possessive_pronoun: "hers", reflexive: "herself" }]); // true
+```
+
+CommonJS and bundler-resolved paths also work via the package exports:
+
+```js
+const schema = require("@openpronoun/schema");
+// or resolve the file directly:
+import schemaUrl from "@openpronoun/schema/pronoun-set.schema.json";
+```
+
+## What it validates
+
+A `PronounPreference` is an array of one or more entries. Each entry is one of:
+
+- a **standard set** — five English forms in full keys (`subjective`, `objective`,
+  `possessive_adjective`, `possessive_pronoun`, `reflexive`) or compact keys
+  (`sub`, `obj`, `p_a`, `p_pn`, `ref`);
+- a **special preference** — `{ "type": "any" | "none" | "ask" | "unspecified" }`;
+- a **custom** entry — `{ "type": "custom", "display": "…" }`, optionally with
+  form fields.
+
+Optional per-entry fields: `ranking`/`rnk`, `context`/`ctx`, `privacy`/`pvc`,
+`language`/`lang` (ISO 639-1), and `exclude`/`exc`.
+
+See the [data model](https://openpronoun.org/specification/data-model/) and
+[conformance](https://openpronoun.org/specification/conformance/) docs for the
+full normative definition.
+
+## Note
+
+This package ships only the schema. TypeScript types can be generated from it at
+build time (e.g. with `json-schema-to-typescript`) in a downstream package if
+desired.

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@openpronoun/schema",
+  "version": "0.0.0",
+  "description": "Canonical JSON Schema for the OpenPronoun data model (PronounPreference / PronounSet).",
+  "license": "MIT",
+  "type": "module",
+  "files": [
+    "pronoun-set.schema.json",
+    "README.md"
+  ],
+  "exports": {
+    ".": "./pronoun-set.schema.json",
+    "./pronoun-set.schema.json": "./pronoun-set.schema.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/pronoun-set.schema.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://openpronoun.org/schemas/pronoun-set.schema.json",
+  "title": "PronounPreference",
+  "description": "An ordered collection of one or more pronoun entries. Each entry is a standard pronoun set, a special preference (any/none/ask), or a custom entry.",
+  "type": "array",
+  "minItems": 1,
+  "items": { "$ref": "#/$defs/pronounEntry" },
+
+  "$defs": {
+    "pronounEntry": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "subjective": { "type": "string", "minLength": 1 },
+        "objective": { "type": "string", "minLength": 1 },
+        "possessive_adjective": { "type": "string", "minLength": 1 },
+        "possessive_pronoun": { "type": "string", "minLength": 1 },
+        "reflexive": { "type": "string", "minLength": 1 },
+
+        "sub": { "type": "string", "minLength": 1 },
+        "obj": { "type": "string", "minLength": 1 },
+        "p_a": { "type": "string", "minLength": 1 },
+        "p_pn": { "type": "string", "minLength": 1 },
+        "ref": { "type": "string", "minLength": 1 },
+
+        "type": { "enum": ["any", "none", "ask", "unspecified", "custom"] },
+        "display": { "type": "string", "minLength": 1 },
+
+        "ranking": { "type": "integer" },
+        "rnk": { "type": "integer" },
+        "exclude": { "type": "boolean" },
+        "exc": { "type": "boolean" },
+        "context": { "type": "string" },
+        "ctx": { "type": "string" },
+        "privacy": { "type": "integer", "minimum": 0 },
+        "pvc": { "type": "integer", "minimum": 0 },
+        "language": { "type": "string", "pattern": "^[a-z]{2}$" },
+        "lang": { "type": "string", "pattern": "^[a-z]{2}$" }
+      },
+
+      "allOf": [
+        {
+          "$comment": "A standard set (no type) MUST provide all five forms, in either full or compact keys.",
+          "if": { "not": { "required": ["type"] } },
+          "then": {
+            "oneOf": [
+              { "required": ["subjective", "objective", "possessive_adjective", "possessive_pronoun", "reflexive"] },
+              { "required": ["sub", "obj", "p_a", "p_pn", "ref"] }
+            ]
+          }
+        },
+        {
+          "$comment": "A custom entry MUST carry a display string; form fields are optional.",
+          "if": {
+            "properties": { "type": { "const": "custom" } },
+            "required": ["type"]
+          },
+          "then": { "required": ["display"] }
+        }
+      ]
+    }
+  }
+}