pi-outpost 0.32.4 → 0.34.0

package/dist/contract/schemas/structured-exchange-profile-registry-2.json

@@ -0,0 +1,94 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "urn:structured-exchange-profile-registry:2",
+  "title": "Structured exchange profile registry v2",
+  "description": "Version 1 plus the project's appearance: colours for the kinds its documents use, applied wherever a kind is coloured and never written into a document. Profiles become optional, so a project may declare only its colours. Kept at .pi-outpost/structured-exchange.json in the project.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema"
+  ],
+  "properties": {
+    "schema": {
+      "description": "Which registry format this is.",
+      "const": "urn:structured-exchange-profile-registry:2"
+    },
+    "profiles": {
+      "description": "Profile files, by path relative to the project directory. Each must stay inside the project. May be empty or absent: a registry without profiles constrains no document.",
+      "type": "array",
+      "minItems": 0,
+      "maxItems": 20,
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 500
+      }
+    },
+    "rules": {
+      "description": "Rules files, by path relative to the project directory. Each names the registered profile it applies to, and is checked against that profile's vocabulary whenever it is read.",
+      "type": "array",
+      "maxItems": 20,
+      "items": {
+        "type": "string",
+        "minLength": 1,
+        "maxLength": 500
+      }
+    },
+    "default": {
+      "description": "The identifier of a registered profile that documents naming no profile are held to. Declaring one also refuses documents that name an unregistered profile, and version 1 documents.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200
+    },
+    "appearance": {
+      "description": "The project's colours for kinds, by vocabulary. A name in one map does not colour the other vocabulary; a kind not named keeps its automatic colour.",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "kinds": {
+          "type": "object",
+          "maxProperties": 64,
+          "propertyNames": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 100
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/kindAppearance"
+          },
+          "description": "Kinds of elements, participants, table rows and timeline items."
+        },
+        "relationshipKinds": {
+          "type": "object",
+          "maxProperties": 64,
+          "propertyNames": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 100
+          },
+          "additionalProperties": {
+            "$ref": "#/$defs/kindAppearance"
+          },
+          "description": "Kinds of relationships and table relations."
+        }
+      }
+    }
+  },
+  "$defs": {
+    "kindAppearance": {
+      "description": "How one kind is drawn. Colour only; the renderer derives lighter fills from it.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "color"
+      ],
+      "properties": {
+        "color": {
+          "description": "A six-digit hexadecimal colour, #rrggbb.",
+          "type": "string",
+          "pattern": "^#[0-9a-fA-F]{6}$"
+        }
+      }
+    }
+  }
+}

package/dist/contract/structured-exchange-project-setup.md

@@ -192,6 +192,42 @@ files; the second prints the profile and every rule beside the conditions it che
 both views. A registry, profile or rules file that cannot be used exits **4**, with every issue, its
 file and a pointer.
 
+## Project colours
+
+A project can give the kinds its documents use the colours of its own conventions — reviews in
+red, phases in the colours of the planning tool everyone already reads. Declare them in the
+registry, as version 2:
+
+```json
+{
+  "schema": "urn:structured-exchange-profile-registry:2",
+  "profiles": ["profiles/requirements.json"],
+  "appearance": {
+    "kinds": {
+      "SRR": { "color": "#dc2626" },
+      "requirement": { "color": "#2563eb" }
+    },
+    "relationshipKinds": {
+      "verifies": { "color": "#16a34a" }
+    }
+  }
+}
+```
+
+- `kinds` colours elements, sequence participants and timeline activities and milestones;
+  `relationshipKinds` colours relationships. A name in one map never colours the other.
+- A colour is `#rrggbb`. Anything else — `"red"`, `"#d22"` — makes the registry unusable, like any
+  other registry fault: every document is refused, with the registry file and a pointer to the
+  colour, until it is fixed.
+- Kinds you do not name keep their automatic colour, which never reuses one of yours in the same
+  drawing. Two kinds you give the same colour keep it; the legend says they share it.
+- Every drawing applies them: documents the agent presents, blocks in its replies, files opened in
+  the viewer, and figures it writes with `write_structure_figure`. No document ever carries a colour.
+- `profiles` is optional in version 2: a registry with only `appearance` constrains no document.
+  Version 1 registries are read exactly as before and declare no colours.
+- An edited registry is applied to the next document presented or reply received, or when the
+  page reloads — no restart.
+
 ## Changing a model in use
 
 Documents are checked against the files as they are when shown. Removing an enumeration value or