pi-outpost 0.9.1 → 0.10.0

package/dist/contract/README.md

@@ -129,6 +129,40 @@ and an explicit white ground, so what lands in the document is what was on scree
 earlier version drew them as HTML inside `foreignObject`, which looks identical in the
 browser and loses everything the moment it is serialized.
 
+## A table that reports a change
+
+A table cannot be proposed — it has no identity per row for a patch to join against,
+and an envelope declaring a table with a `target` or a `removal` is refused. It can
+still report on a change it projects. Any row may declare what it plays:
+
+```json
+"rows": [
+  { "role": "added",   "cells": ["REQ-5", "Log every actuation.", "draft"] },
+  { "role": "changed", "cells": ["REQ-2", "Signal a fault within 200 ms.", "in review"] },
+  { "role": "removed", "cells": ["REQ-3", "Read battery voltage at 10 Hz.", "withdrawn"] },
+  { "cells": ["REQ-1", "Stop within 40 m.", "approved"] }
+]
+```
+
+`role` is `added`, `changed`, `context` or `removed`, and it is rendered with the
+colours a graph uses for the same words. A row that declares none reads as context
+among rows that do. Both row forms are accepted for the life of version 1, so
+`["REQ-1", "…"]` and `{ "cells": ["REQ-1", "…"] }` are the same row and a table that
+declares no role anywhere renders exactly as it did before roles existed.
+
+Declare the role rather than encoding it in a column. A `status` column of your own
+vocabulary is data, and is rendered as data — nothing infers a role from a cell.
+
+A reader can switch a role off from the key, which narrows the table to the rows that
+remain, and can take the table away with **download CSV** or **download XLSX**. Where
+rows declare roles, both exports carry a `change` column, because the colour that
+states the role in the rendering does not survive the crossing. A narrowed table
+exports only what it shows, and the controls say so.
+
+Old consumers: a copy of the widget published before roles existed validates against
+its own committed schema, so a role-carrying table is refused there and the tool
+result falls back to raw output. It degrades; it does not break.
+
 ## If you are not building in this repository
 
 You do not need our command-line interface, and you do not need this repository. The

package/dist/contract/conformance/index.json

@@ -50,6 +50,12 @@
     },
     {
       "file": "valid/graph-containers-at-the-ceiling.json"
+    },
+    {
+      "file": "valid/table-rows-with-roles.json"
+    },
+    {
+      "file": "valid/table-rows-partly-roled.json"
     }
   ],
   "invalid": [
@@ -160,6 +166,18 @@
     {
       "file": "invalid/containers-over-the-ceiling.json",
       "expectedRule": "schema/maxItems"
+    },
+    {
+      "file": "invalid/table-row-unknown-role.json",
+      "expectedRule": "schema/enum"
+    },
+    {
+      "file": "invalid/table-row-without-cells.json",
+      "expectedRule": "schema/required"
+    },
+    {
+      "file": "invalid/table-row-object-column-mismatch.json",
+      "expectedRule": "row-column-mismatch"
     }
   ]
 }

package/dist/contract/conformance/invalid/table-row-object-column-mismatch.json

@@ -0,0 +1,18 @@
+{
+  "schema": "urn:structured-exchange:1",
+  "kind": "table",
+  "data": {
+    "columns": [
+      "id",
+      "requirement"
+    ],
+    "rows": [
+      {
+        "role": "added",
+        "cells": [
+          "only-one"
+        ]
+      }
+    ]
+  }
+}

package/dist/contract/conformance/invalid/table-row-unknown-role.json

@@ -0,0 +1,17 @@
+{
+  "schema": "urn:structured-exchange:1",
+  "kind": "table",
+  "data": {
+    "columns": [
+      "id"
+    ],
+    "rows": [
+      {
+        "role": "deleted",
+        "cells": [
+          "REQ-001"
+        ]
+      }
+    ]
+  }
+}

package/dist/contract/conformance/invalid/table-row-without-cells.json

@@ -0,0 +1,14 @@
+{
+  "schema": "urn:structured-exchange:1",
+  "kind": "table",
+  "data": {
+    "columns": [
+      "id"
+    ],
+    "rows": [
+      {
+        "role": "added"
+      }
+    ]
+  }
+}

package/dist/contract/conformance/valid/table-rows-partly-roled.json

@@ -0,0 +1,29 @@
+{
+  "schema": "urn:structured-exchange:1",
+  "kind": "table",
+  "data": {
+    "columns": [
+      "id",
+      "requirement"
+    ],
+    "rows": [
+      {
+        "role": "added",
+        "cells": [
+          "REQ-005",
+          "A new one."
+        ]
+      },
+      {
+        "cells": [
+          "REQ-001",
+          "A row that declares no role."
+        ]
+      },
+      [
+        "REQ-002",
+        "A row still written as a bare array."
+      ]
+    ]
+  }
+}

package/dist/contract/conformance/valid/table-rows-with-roles.json

@@ -0,0 +1,45 @@
+{
+  "schema": "urn:structured-exchange:1",
+  "kind": "table",
+  "data": {
+    "columns": [
+      "id",
+      "requirement",
+      "status"
+    ],
+    "rows": [
+      {
+        "role": "added",
+        "cells": [
+          "REQ-005",
+          "The system shall log every actuation.",
+          "draft"
+        ]
+      },
+      {
+        "role": "changed",
+        "cells": [
+          "REQ-002",
+          "The dashboard shall signal a fault within 200 ms.",
+          "in review"
+        ]
+      },
+      {
+        "role": "context",
+        "cells": [
+          "REQ-001",
+          "The braking system shall stop the vehicle.",
+          "approved"
+        ]
+      },
+      {
+        "role": "removed",
+        "cells": [
+          "REQ-003",
+          "The ECU shall read battery voltage at 10 Hz.",
+          "withdrawn"
+        ]
+      }
+    ]
+  }
+}

package/dist/contract/schemas/structured-exchange-1.json

@@ -236,6 +236,19 @@
           "$ref": "#/$defs/label"
         }
       }
+    },
+    "cells": {
+      "type": "array",
+      "items": {
+        "type": [
+          "string",
+          "number",
+          "boolean",
+          "null"
+        ],
+        "maxLength": 1000
+      },
+      "maxItems": 50
     }
   },
   "properties": {
@@ -347,17 +360,31 @@
               "type": "array",
               "maxItems": 5000,
               "items": {
-                "type": "array",
-                "items": {
-                  "type": [
-                    "string",
-                    "number",
-                    "boolean",
-                    "null"
-                  ],
-                  "maxLength": 1000
-                },
-                "maxItems": 50
+                "oneOf": [
+                  {
+                    "$ref": "#/$defs/cells"
+                  },
+                  {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "required": [
+                      "cells"
+                    ],
+                    "properties": {
+                      "cells": {
+                        "$ref": "#/$defs/cells"
+                      },
+                      "role": {
+                        "enum": [
+                          "added",
+                          "changed",
+                          "context",
+                          "removed"
+                        ]
+                      }
+                    }
+                  }
+                ]
               }
             }
           }

package/dist/contract/validate-structured-exchange.mjs

@@ -10,6 +10,9 @@ import { readFileSync } from "node:fs";
 
 // shared/src/structuredExchange.ts
 var PROPOSABLE_KINDS = ["graph", "sequence"];
+function readTableRow(row) {
+  return Array.isArray(row) ? { cells: row } : { cells: row.cells, role: row.role };
+}
 var STRUCTURED_EXCHANGE_CEILINGS = {
   nodes: 500,
   edges: 2e3,
@@ -282,12 +285,13 @@ function validateStructuredExchangeSemantics(envelope) {
   if (envelope.kind === "table") {
     const { columns, rows } = envelope.data;
     rows.forEach((row, index3) => {
-      if (row.length !== columns.length) {
+      const { cells } = readTableRow(row);
+      if (cells.length !== columns.length) {
         issues.push({
           rule: "row-column-mismatch",
           path: `/data/rows/${index3}`,
-          message: `row has ${row.length} values but ${columns.length} columns are declared`,
-          observed: row.length,
+          message: `row has ${cells.length} values but ${columns.length} columns are declared`,
+          observed: cells.length,
           limit: columns.length
         });
       }
@@ -8442,6 +8446,19 @@ var structured_exchange_1_default = {
           $ref: "#/$defs/label"
         }
       }
+    },
+    cells: {
+      type: "array",
+      items: {
+        type: [
+          "string",
+          "number",
+          "boolean",
+          "null"
+        ],
+        maxLength: 1e3
+      },
+      maxItems: 50
     }
   },
   properties: {
@@ -8553,17 +8570,31 @@ var structured_exchange_1_default = {
               type: "array",
               maxItems: 5e3,
               items: {
-                type: "array",
-                items: {
-                  type: [
-                    "string",
-                    "number",
-                    "boolean",
-                    "null"
-                  ],
-                  maxLength: 1e3
-                },
-                maxItems: 50
+                oneOf: [
+                  {
+                    $ref: "#/$defs/cells"
+                  },
+                  {
+                    type: "object",
+                    additionalProperties: false,
+                    required: [
+                      "cells"
+                    ],
+                    properties: {
+                      cells: {
+                        $ref: "#/$defs/cells"
+                      },
+                      role: {
+                        enum: [
+                          "added",
+                          "changed",
+                          "context",
+                          "removed"
+                        ]
+                      }
+                    }
+                  }
+                ]
               }
             }
           }