npm - yarramate - Versions diffs - 0.5.0 → 0.7.0 - Mend

yarramate 0.5.0 → 0.7.0

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 (48) hide show

package/README.md +39 -10
package/catalogues/core-enrichment.yaml +700 -0
package/dist/adapters/likec4-cli.js +179 -55
package/dist/adapters/likec4-export.d.ts +1 -1
package/dist/adapters/likec4-prepare.d.ts +6 -0
package/dist/adapters/likec4-prepare.js +40 -2
package/dist/adapters/mcp-cli.js +55 -49
package/dist/apply-command.d.ts +2 -0
package/dist/apply-command.js +199 -0
package/dist/{new-command.d.ts → ask-command.d.ts} +1 -1
package/dist/ask-command.js +729 -0
package/dist/brief.d.ts +3 -0
package/dist/brief.js +235 -0
package/dist/check-command.js +70 -4
package/dist/cli-support.d.ts +4 -1
package/dist/cli-support.js +3 -2
package/dist/cli.js +22 -586
package/dist/compiler.js +45 -7
package/dist/core-contract.d.ts +1 -1
package/dist/{status-command.d.ts → design-command.d.ts} +1 -1
package/dist/design-command.js +218 -0
package/dist/export-command.d.ts +2 -0
package/dist/export-command.js +228 -0
package/dist/interrogate-command.d.ts +104 -0
package/dist/interrogate-command.js +268 -0
package/dist/next-command.d.ts +22 -0
package/dist/next-command.js +167 -0
package/dist/reconciliation.d.ts +2 -0
package/dist/reconciliation.js +38 -0
package/docs/CONSUMING-YARRAMATE.md +28 -21
package/package.json +13 -10
package/schema/yarramate-apply-result.schema.json +32 -0
package/schema/yarramate-ask-result.schema.json +391 -0
package/schema/yarramate-check-result.schema.json +12 -0
package/schema/yarramate-core-contract.schema.json +5 -10
package/schema/yarramate-design-step.schema.json +152 -0
package/schema/yarramate-document.schema.json +76 -9
package/schema/yarramate-interrogation-report.schema.json +89 -0
package/schema/yarramate-likec4-generated-project-v2.schema.json +6 -0
package/schema/yarramate-likec4-generated-project.schema.json +6 -0
package/schema/yarramate-operations.schema.json +303 -0
package/schema/yarramate-question-catalogue.schema.json +431 -0
package/schema/yarramate-reconciliation-report.schema.json +8 -2
package/skills/yarramate-architecture/SKILL.md +42 -17
package/skills/yarramate-architecture/references/native-authoring.md +73 -17
package/dist/new-command.js +0 -111
package/dist/status-command.js +0 -171
package/schema/yarramate-status-result.schema.json +0 -273

package/schema/yarramate-apply-result.schema.json ADDED Viewed

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarrasys.dev/schema/yarramate-apply-result.schema.json",
+  "title": "YarraMate apply result",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "workspace", "applied", "documents"],
+  "properties": {
+    "format": { "const": "yarramate/apply-result/v1" },
+    "workspace": { "type": "string", "minLength": 1 },
+    "applied": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "addedConcepts",
+        "addedRelationships",
+        "updatedConcepts",
+        "updatedRelationships"
+      ],
+      "properties": {
+        "addedConcepts": { "type": "integer", "minimum": 0 },
+        "addedRelationships": { "type": "integer", "minimum": 0 },
+        "updatedConcepts": { "type": "integer", "minimum": 0 },
+        "updatedRelationships": { "type": "integer", "minimum": 0 }
+      }
+    },
+    "documents": {
+      "type": "array",
+      "items": { "type": "string", "minLength": 1 }
+    }
+  }
+}

package/schema/yarramate-ask-result.schema.json ADDED Viewed

@@ -0,0 +1,391 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarrasys.dev/schema/yarramate-ask-result.schema.json",
+  "title": "YarraMate ask result",
+  "description": "One envelope for every consumed-now read: orientation, roster, slice, advice, next, open questions, and state comparison, discriminated by mode.",
+  "type": "object",
+  "required": ["format", "workspace", "mode"],
+  "properties": {
+    "format": {
+      "const": "yarramate/ask-result/v1"
+    },
+    "workspace": {
+      "type": "string",
+      "minLength": 1
+    },
+    "mode": {
+      "enum": [
+        "orientation",
+        "roster",
+        "slice",
+        "advice",
+        "next",
+        "open",
+        "compare",
+        "kinds"
+      ]
+    }
+  },
+  "oneOf": [
+    {
+      "type": "object",
+      "required": ["mode", "ok", "check", "backlog"],
+      "properties": {
+        "format": true,
+        "workspace": true,
+        "mode": { "const": "orientation" },
+        "ok": { "type": "boolean" },
+        "check": {
+          "type": "object",
+          "required": ["ok", "diagnostics"],
+          "properties": {
+            "ok": { "type": "boolean" },
+            "diagnostics": { "type": "array" },
+            "counted": {
+              "type": "object",
+              "required": [
+                "documents",
+                "concepts",
+                "relationships",
+                "states"
+              ],
+              "properties": {
+                "documents": { "type": "integer" },
+                "concepts": { "type": "integer" },
+                "relationships": { "type": "integer" },
+                "states": { "type": "integer" }
+              },
+              "additionalProperties": false
+            }
+          },
+          "additionalProperties": false
+        },
+        "reconciliation": {
+          "$ref": "#/$defs/reconciliationSummary"
+        },
+        "design": {
+          "type": "object",
+          "required": ["catalogue", "open"],
+          "properties": {
+            "catalogue": { "type": "string", "minLength": 1 },
+            "open": { "type": "integer", "minimum": 0 }
+          },
+          "additionalProperties": false
+        },
+        "backlog": {
+          "type": "object",
+          "required": ["planned", "current", "retired"],
+          "properties": {
+            "planned": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/nextSubject" }
+            },
+            "current": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/conceptEntry" }
+            },
+            "retired": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/conceptEntry" }
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "required": ["mode", "total", "subjects"],
+      "properties": {
+        "format": true,
+        "workspace": true,
+        "mode": { "const": "roster" },
+        "total": { "type": "integer", "minimum": 0 },
+        "subjects": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/conceptEntry" }
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "required": ["mode", "addressing", "result"],
+      "properties": {
+        "format": true,
+        "workspace": true,
+        "mode": { "const": "slice" },
+        "addressing": {
+          "enum": ["free-text", "subjects", "projection"]
+        },
+        "topic": { "type": "string", "minLength": 1 },
+        "seeds": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "matched": { "type": "integer", "minimum": 0 },
+        "result": { "$ref": "#/$defs/projectionResult" }
+      },
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "required": [
+        "mode",
+        "topic",
+        "seeds",
+        "matched",
+        "slice",
+        "openQuestions"
+      ],
+      "properties": {
+        "format": true,
+        "workspace": true,
+        "mode": { "const": "advice" },
+        "topic": { "type": "string", "minLength": 1 },
+        "seeds": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "matched": { "type": "integer", "minimum": 0 },
+        "slice": { "type": "string", "minLength": 1 },
+        "openQuestions": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["wave", "id", "authority", "question", "materiality"],
+            "properties": {
+              "wave": { "type": "string", "minLength": 1 },
+              "id": { "type": "string", "minLength": 1 },
+              "authority": { "enum": ["human", "agent", "either"] },
+              "question": { "type": "string", "minLength": 1 },
+              "materiality": { "type": "string", "minLength": 1 },
+              "subject": { "type": "string", "minLength": 1 }
+            },
+            "additionalProperties": false
+          }
+        },
+        "reconciliation": {
+          "type": "object",
+          "required": ["summary", "findings"],
+          "properties": {
+            "summary": { "$ref": "#/$defs/reconciliationSummary" },
+            "findings": { "type": "array" }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "required": ["mode", "subjects"],
+      "properties": {
+        "format": true,
+        "workspace": true,
+        "mode": { "const": "next" },
+        "subjects": {
+          "type": "array",
+          "items": { "$ref": "#/$defs/nextSubject" }
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "required": ["mode", "report"],
+      "properties": {
+        "format": true,
+        "workspace": true,
+        "mode": { "const": "open" },
+        "report": {
+          "type": "object",
+          "required": ["format", "workspace", "catalogue", "summary", "waves"],
+          "properties": {
+            "format": { "const": "yarramate/interrogation-report/v1" },
+            "workspace": { "type": "string" },
+            "catalogue": { "type": "string" },
+            "summary": { "type": "object" },
+            "waves": { "type": "array" }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "required": ["mode", "conceptKinds", "relationshipKinds", "extensions"],
+      "properties": {
+        "format": true,
+        "workspace": true,
+        "mode": { "const": "kinds" },
+        "conceptKinds": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["id", "name", "layer", "aspect"],
+            "properties": {
+              "id": { "type": "string", "minLength": 1 },
+              "name": { "type": "string", "minLength": 1 },
+              "layer": { "type": "string", "minLength": 1 },
+              "aspect": { "type": "string", "minLength": 1 },
+              "inspiredBy": { "type": "string" }
+            },
+            "additionalProperties": false
+          }
+        },
+        "relationshipKinds": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["id", "intent"],
+            "properties": {
+              "id": { "type": "string", "minLength": 1 },
+              "intent": { "type": "string", "minLength": 1 },
+              "sourceAspects": {
+                "type": "array",
+                "items": { "type": "string" }
+              },
+              "targetAspects": {
+                "type": "array",
+                "items": { "type": "string" }
+              },
+              "repair": { "type": "string" }
+            },
+            "additionalProperties": false
+          }
+        },
+        "extensions": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": ["id", "type", "lineage"],
+            "properties": {
+              "id": { "type": "string", "minLength": 1 },
+              "type": { "enum": ["concept", "relationship"] },
+              "lineage": {
+                "type": "array",
+                "items": { "type": "string" }
+              }
+            },
+            "additionalProperties": false
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "required": ["mode", "comparison"],
+      "properties": {
+        "format": true,
+        "workspace": true,
+        "mode": { "const": "compare" },
+        "comparison": {
+          "type": "object",
+          "required": ["format", "from", "to", "added", "removed", "retained"],
+          "properties": {
+            "format": { "const": "yarramate/state-comparison/v1" },
+            "from": { "type": "string" },
+            "to": { "type": "string" },
+            "added": { "type": "array" },
+            "removed": { "type": "array" },
+            "retained": { "type": "array" }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  ],
+  "$defs": {
+    "conceptEntry": {
+      "type": "object",
+      "required": ["id", "kind"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "kind": { "type": "string", "minLength": 1 },
+        "name": { "type": "string" },
+        "status": { "enum": ["planned", "current", "retired"] },
+        "description": { "type": "string" }
+      },
+      "additionalProperties": false
+    },
+    "nextSubject": {
+      "type": "object",
+      "required": ["id", "kind", "dependsOn", "requiredBy", "evidence"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "kind": { "type": "string", "minLength": 1 },
+        "name": { "type": "string" },
+        "dependsOn": {
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "requiredBy": {
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "evidence": {
+          "type": "object",
+          "required": [
+            "observations",
+            "confirmed",
+            "contradicted",
+            "unknown",
+            "notObserved"
+          ],
+          "properties": {
+            "observations": { "type": "integer" },
+            "confirmed": { "type": "integer" },
+            "contradicted": { "type": "integer" },
+            "unknown": { "type": "integer" },
+            "notObserved": { "type": "integer" }
+          },
+          "additionalProperties": false
+        },
+        "cycle": { "const": true }
+      },
+      "additionalProperties": false
+    },
+    "projectionResult": {
+      "type": "object",
+      "required": ["format", "projection", "documents", "subjects", "claims"],
+      "properties": {
+        "format": { "const": "yarramate/projection-result/v1" },
+        "projection": { "type": "string" },
+        "presentation": { "type": "object" },
+        "documents": { "type": "array" },
+        "subjects": { "type": "array" },
+        "claims": { "type": "array" }
+      },
+      "additionalProperties": false
+    },
+    "reconciliationSummary": {
+      "type": "object",
+      "required": [
+        "evidenceDocuments",
+        "observations",
+        "confirmed",
+        "findings",
+        "contradicted",
+        "unknown",
+        "notObserved",
+        "subjectsWithoutEvidence"
+      ],
+      "properties": {
+        "evidenceDocuments": { "type": "integer" },
+        "observations": { "type": "integer" },
+        "confirmed": { "type": "integer" },
+        "findings": { "type": "integer" },
+        "contradicted": { "type": "integer" },
+        "unknown": { "type": "integer" },
+        "notObserved": { "type": "integer" },
+        "subjectsWithoutEvidence": { "type": "integer" }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/schema/yarramate-check-result.schema.json CHANGED Viewed

@@ -20,6 +20,9 @@
     },
     "counted": {
       "$ref": "#/$defs/counted"
+    },
+    "strict": {
+      "$ref": "#/$defs/strict"
     }
   },
   "allOf": [
@@ -50,6 +53,15 @@
     }
   ],
   "$defs": {
+    "strict": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["observations", "contradicted"],
+      "properties": {
+        "observations": { "type": "integer", "minimum": 0 },
+        "contradicted": { "type": "integer", "minimum": 0 }
+      }
+    },
     "counted": {
       "type": "object",
       "additionalProperties": false,

package/schema/yarramate-core-contract.schema.json CHANGED Viewed

@@ -67,17 +67,12 @@
           "name": {
             "enum": [
               "init",
-              "add",
-              "connect",
-              "new",
+              "design",
+              "apply",
+              "ask",
               "check",
-              "status",
-              "compile",
-              "view",
-              "context",
-              "compare",
-              "evidence",
-              "reconcile"
+              "reconcile",
+              "export"
             ]
           },
           "binary": {

package/schema/yarramate-design-step.schema.json ADDED Viewed

@@ -0,0 +1,152 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarrasys.dev/schema/yarramate-design-step.schema.json",
+  "title": "YarraMate design step",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "format",
+    "workspace",
+    "catalogue",
+    "progress",
+    "step"
+  ],
+  "properties": {
+    "format": {
+      "const": "yarramate/design-step/v1"
+    },
+    "workspace": {
+      "type": "string",
+      "minLength": 1
+    },
+    "catalogue": {
+      "type": "string",
+      "minLength": 1
+    },
+    "progress": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "questions",
+        "openQuestions",
+        "open",
+        "waves"
+      ],
+      "properties": {
+        "questions": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "openQuestions": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "open": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "waves": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "id",
+              "open"
+            ],
+            "properties": {
+              "id": {
+                "type": "string",
+                "minLength": 1
+              },
+              "open": {
+                "type": "integer",
+                "minimum": 0
+              }
+            }
+          }
+        }
+      }
+    },
+    "step": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "questionId",
+            "wave",
+            "scope",
+            "authority",
+            "question",
+            "materiality",
+            "resolution"
+          ],
+          "properties": {
+            "questionId": {
+              "type": "string",
+              "minLength": 1
+            },
+            "wave": {
+              "type": "string",
+              "minLength": 1
+            },
+            "scope": {
+              "enum": [
+                "workspace",
+                "subject"
+              ]
+            },
+            "authority": {
+              "enum": [
+                "human",
+                "agent",
+                "either"
+              ]
+            },
+            "question": {
+              "type": "string",
+              "minLength": 1
+            },
+            "materiality": {
+              "type": "string",
+              "minLength": 1
+            },
+            "resolution": {
+              "type": "string",
+              "minLength": 1
+            },
+            "subject": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "id"
+              ],
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "name": {
+                  "type": "string",
+                  "minLength": 1
+                }
+              }
+            },
+            "remainingSubjects": {
+              "type": "integer",
+              "minimum": 1
+            }
+          }
+        }
+      ]
+    },
+    "slice": {
+      "type": "string",
+      "minLength": 1
+    }
+  }
+}