@superjackfruitlabs/treaty-event-schemas 0.0.7 → 0.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +2 -2
  2. package/schemas/README.md +19 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@superjackfruitlabs/treaty-event-schemas",
3
- "version": "0.0.7",
3
+ "version": "0.0.9",
4
4
  "description": "JSON Schemas for the events Super Jackfruit Labs products send, and the catalogue that names their CloudEvents types.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -23,7 +23,7 @@
23
23
  "LICENSE"
24
24
  ],
25
25
  "scripts": {
26
- "build": "rm -rf dist schemas && mkdir -p schemas && cp -R ../../schemas/. schemas/ && tsc -p tsconfig.build.json"
26
+ "build": "rm -rf dist schemas && mkdir -p schemas && cp ../../schemas/catalog.json ../../schemas/README.md schemas/ && cp -R ../../schemas/superpipeline schemas/ && tsc -p tsconfig.build.json"
27
27
  },
28
28
  "publishConfig": {
29
29
  "access": "public",
package/schemas/README.md CHANGED
@@ -27,3 +27,22 @@ changing what one means, is a new version published beside the old one.
27
27
  `https://docs.superwitness.dev/schemas/run-report.schema.json`. The catalogue points at it.
28
28
  - **SuperPipeline's other pushed events** (`delivery.pending`, `attention.pending`, the decision
29
29
  notices, `check.failed` and the rest) come in a later change.
30
+
31
+ ## Matrix (`matrix/`)
32
+
33
+ One schema per board-room Matrix event, named by its type string: the gates, questions,
34
+ follow-ups, waiting cards, notices and receipts a board's work crosses chat on, the answers a
35
+ person sends back, and AgentPod's harness permission envelope. Plain data, so SuperMessage's Rust
36
+ core and a Swift client read them without TypeScript. Published in
37
+ `@superjackfruitlabs/treaty-matrix-events` (`packages/matrix-events`), which also holds the
38
+ TypeScript that builds and reads them.
39
+
40
+ - Three files describe a card that rides inside a prose message under a content key rather than as
41
+ an event of its own: `dev.superpipeline.gate`, `dev.superpipeline.elicitation` and
42
+ `dev.agentpod.permission`.
43
+ - `x-uniqueBy` lists the paths whose values must not repeat, the one rule JSON Schema cannot state:
44
+ `options[].id` is the `id` of every option.
45
+ - `fixtures/matrix-events/examples.json` is the corpus they are checked against, built by
46
+ `scripts/matrix-examples.ts` from `fixtures/ecosystem-identity/matrix_gate_events.json` and from
47
+ this package's builders. Each invalid case says what refuses it: the schema, a uniqueness rule, or
48
+ only the carrier, against what it recorded when it posted.