yarramate 0.1.0

package/schema/yarramate-diagnostic-result.schema.json

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/diagnostic-result/v1",
+  "title": "YarraMate diagnostic result",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "diagnostics"],
+  "properties": {
+    "format": {
+      "const": "yarramate/diagnostic-result/v1"
+    },
+    "diagnostics": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/$defs/diagnostic"
+      }
+    }
+  },
+  "$defs": {
+    "diagnostic": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "severity",
+        "code",
+        "message",
+        "path",
+        "pointer",
+        "line",
+        "column"
+      ],
+      "properties": {
+        "severity": {
+          "const": "error"
+        },
+        "code": {
+          "type": "string",
+          "pattern": "^YM[0-9]{3}$"
+        },
+        "message": {
+          "type": "string",
+          "minLength": 1
+        },
+        "path": {
+          "type": "string",
+          "minLength": 1
+        },
+        "pointer": {
+          "type": "string",
+          "pattern": "^/"
+        },
+        "line": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "column": {
+          "type": "integer",
+          "minimum": 1
+        }
+      }
+    }
+  }
+}

package/schema/yarramate-document.schema.json

@@ -0,0 +1,168 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/document/v1",
+  "title": "YarraMate native document",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "id", "profile", "concepts", "relationships"],
+  "properties": {
+    "format": {
+      "const": "yarramate/v1"
+    },
+    "id": {
+      "$ref": "#/$defs/id"
+    },
+    "profile": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]*(?:/[a-z][a-z0-9-]*)+@[0-9]+\\.[0-9]+$"
+    },
+    "states": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/architectureState"
+      }
+    },
+    "concepts": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/concept"
+      }
+    },
+    "relationships": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/relationship"
+      }
+    }
+  },
+  "$defs": {
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "nonEmptyText": {
+      "type": "string",
+      "minLength": 1
+    },
+    "reference": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:#[a-z][a-z0-9]*(?:-[a-z0-9]+)*)?$"
+    },
+    "architectureState": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "kind", "name"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "kind": {
+          "enum": ["baseline", "transition", "target"]
+        },
+        "name": {
+          "$ref": "#/$defs/nonEmptyText"
+        },
+        "description": {
+          "$ref": "#/$defs/nonEmptyText"
+        },
+        "after": {
+          "$ref": "#/$defs/reference"
+        }
+      }
+    },
+    "concept": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "kind", "name"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "kind": {
+          "type": "string",
+          "minLength": 1
+        },
+        "name": {
+          "$ref": "#/$defs/nonEmptyText"
+        },
+        "description": {
+          "$ref": "#/$defs/nonEmptyText"
+        },
+        "status": {
+          "$ref": "#/$defs/lifecycleStatus"
+        },
+        "owner": {
+          "$ref": "#/$defs/reference"
+        },
+        "constraints": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/constraint"
+          }
+        },
+        "presentIn": {
+          "$ref": "#/$defs/stateReferences"
+        }
+      }
+    },
+    "constraint": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "ref"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "ref": {
+          "$ref": "#/$defs/reference"
+        }
+      }
+    },
+    "relationship": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "kind", "from", "to"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/id"
+        },
+        "kind": {
+          "type": "string",
+          "minLength": 1
+        },
+        "from": {
+          "$ref": "#/$defs/reference"
+        },
+        "to": {
+          "$ref": "#/$defs/reference"
+        },
+        "name": {
+          "$ref": "#/$defs/nonEmptyText"
+        },
+        "mode": {
+          "enum": ["read", "write", "read-write", "unspecified"]
+        },
+        "content": {
+          "$ref": "#/$defs/nonEmptyText"
+        },
+        "status": {
+          "$ref": "#/$defs/lifecycleStatus"
+        },
+        "presentIn": {
+          "$ref": "#/$defs/stateReferences"
+        }
+      }
+    },
+    "stateReferences": {
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/reference"
+      }
+    },
+    "lifecycleStatus": {
+      "enum": ["planned", "current", "retired"]
+    }
+  }
+}

package/schema/yarramate-evidence-report.schema.json

@@ -0,0 +1,73 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/evidence-report/v1",
+  "title": "YarraMate evidence report",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "evidence", "provider", "summary", "observations"],
+  "properties": {
+    "format": { "const": "yarramate/evidence-report/v1" },
+    "evidence": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*@[0-9]+\\.[0-9]+$"
+    },
+    "provider": { "$ref": "#/$defs/id" },
+    "summary": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["confirmed", "contradicted", "unknown", "notObserved"],
+      "properties": {
+        "confirmed": { "type": "integer", "minimum": 0 },
+        "contradicted": { "type": "integer", "minimum": 0 },
+        "unknown": { "type": "integer", "minimum": 0 },
+        "notObserved": { "type": "integer", "minimum": 0 }
+      }
+    },
+    "observations": {
+      "type": "array",
+      "items": { "$ref": "#/$defs/observation" }
+    }
+  },
+  "$defs": {
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "qualifiedIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*#[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:~[a-z][a-z0-9-]*)?$"
+    },
+    "evidenceLocator": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["uri"],
+      "properties": {
+        "uri": { "type": "string", "minLength": 1 },
+        "message": { "type": "string", "minLength": 1 }
+      }
+    },
+    "observation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["result", "evidence"],
+      "properties": {
+        "subject": { "$ref": "#/$defs/qualifiedIdentity" },
+        "claim": { "$ref": "#/$defs/qualifiedIdentity" },
+        "result": {
+          "enum": ["confirmed", "contradicted", "unknown", "not-observed"]
+        },
+        "evidence": { "$ref": "#/$defs/evidenceLocator" }
+      },
+      "oneOf": [
+        {
+          "required": ["subject"],
+          "not": { "required": ["claim"] }
+        },
+        {
+          "required": ["claim"],
+          "not": { "required": ["subject"] }
+        }
+      ]
+    }
+  }
+}

package/schema/yarramate-evidence.schema.json

@@ -0,0 +1,92 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/evidence/v1",
+  "title": "YarraMate evidence overlay",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "id", "version", "provider", "observations"],
+  "properties": {
+    "format": {
+      "const": "yarramate/evidence/v1"
+    },
+    "id": {
+      "$ref": "#/$defs/id"
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+$"
+    },
+    "provider": {
+      "$ref": "#/$defs/id"
+    },
+    "observations": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/observation"
+      }
+    }
+  },
+  "$defs": {
+    "id": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "qualifiedIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*#[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:~[a-z][a-z0-9-]*)?$"
+    },
+    "evidenceLocator": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["uri"],
+      "properties": {
+        "uri": {
+          "type": "string",
+          "minLength": 1
+        },
+        "message": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "observation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["result", "evidence"],
+      "properties": {
+        "subject": {
+          "$ref": "#/$defs/qualifiedIdentity"
+        },
+        "claim": {
+          "$ref": "#/$defs/qualifiedIdentity"
+        },
+        "result": {
+          "enum": [
+            "confirmed",
+            "contradicted",
+            "unknown",
+            "not-observed"
+          ]
+        },
+        "evidence": {
+          "$ref": "#/$defs/evidenceLocator"
+        }
+      },
+      "oneOf": [
+        {
+          "required": ["subject"],
+          "not": {
+            "required": ["claim"]
+          }
+        },
+        {
+          "required": ["claim"],
+          "not": {
+            "required": ["subject"]
+          }
+        }
+      ]
+    }
+  }
+}

package/schema/yarramate-graph-v2.schema.json

@@ -0,0 +1,170 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/graph/v2",
+  "title": "YarraMate semantic graph v2",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "profiles", "documents", "subjects", "claims"],
+  "properties": {
+    "format": {
+      "const": "yarramate/graph/v2"
+    },
+    "profiles": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/profileIdentity"
+      }
+    },
+    "documents": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/document"
+      }
+    },
+    "subjects": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/subject"
+      }
+    },
+    "claims": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/$defs/claim"
+      }
+    }
+  },
+  "$defs": {
+    "localId": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "profileIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]*(?:/[a-z][a-z0-9-]*)+@[0-9]+\\.[0-9]+$"
+    },
+    "subjectIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*#[a-z][a-z0-9]*(?:-[a-z0-9]+)*$"
+    },
+    "claimIdentity": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*#[a-z][a-z0-9]*(?:-[a-z0-9]+)*(?:~[a-z][a-z0-9-]*)?$"
+    },
+    "document": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "source"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/localId"
+        },
+        "source": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "subject": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "type"],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/subjectIdentity"
+        },
+        "type": {
+          "enum": ["concept", "relationship"]
+        }
+      }
+    },
+    "claimObject": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["ref"],
+          "properties": {
+            "ref": {
+              "$ref": "#/$defs/subjectIdentity"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["value"],
+          "properties": {
+            "value": {
+              "type": "string",
+              "minLength": 1
+            }
+          }
+        }
+      ]
+    },
+    "source": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["document", "path", "pointer", "line", "column"],
+      "properties": {
+        "document": {
+          "$ref": "#/$defs/localId"
+        },
+        "path": {
+          "type": "string",
+          "minLength": 1
+        },
+        "pointer": {
+          "type": "string",
+          "pattern": "^/"
+        },
+        "line": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "column": {
+          "type": "integer",
+          "minimum": 1
+        }
+      }
+    },
+    "claim": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "id",
+        "subject",
+        "predicate",
+        "object",
+        "origin",
+        "source"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/claimIdentity"
+        },
+        "subject": {
+          "$ref": "#/$defs/subjectIdentity"
+        },
+        "predicate": {
+          "type": "string",
+          "pattern": "^\\S+$"
+        },
+        "object": {
+          "$ref": "#/$defs/claimObject"
+        },
+        "origin": {
+          "const": "declared"
+        },
+        "source": {
+          "$ref": "#/$defs/source"
+        }
+      }
+    }
+  }
+}

package/schema/yarramate-likec4-check-result.schema.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.org/schema/likec4-check-result/v1",
+  "title": "YarraMate LikeC4 check result",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "ok", "diagnostics"],
+  "properties": {
+    "format": {
+      "const": "yarramate/likec4-check-result/v1"
+    },
+    "ok": {
+      "type": "boolean"
+    },
+    "diagnostics": {
+      "type": "array",
+      "items": {
+        "$ref": "https://yarramate.dev/schema/yarramate-likec4-diagnostic-result.schema.json#/properties/diagnostics/items"
+      }
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "ok": {
+            "const": true
+          }
+        },
+        "required": ["ok"]
+      },
+      "then": {
+        "properties": {
+          "diagnostics": {
+            "type": "array",
+            "maxItems": 0
+          }
+        }
+      },
+      "else": {
+        "properties": {
+          "diagnostics": {
+            "type": "array",
+            "minItems": 1
+          }
+        }
+      }
+    }
+  ]
+}

package/schema/yarramate-likec4-diagnostic-result.schema.json

@@ -0,0 +1,69 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://yarramate.dev/schema/yarramate-likec4-diagnostic-result.schema.json",
+  "title": "YarraMate LikeC4 diagnostic result",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["format", "diagnostics"],
+  "properties": {
+    "format": {
+      "const": "yarramate/likec4-diagnostic-result/v1"
+    },
+    "diagnostics": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "oneOf": [
+          {
+            "$ref": "https://yarramate.org/schema/diagnostic-result/v1#/$defs/diagnostic"
+          },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+              "severity",
+              "code",
+              "message",
+              "path",
+              "pointer",
+              "line",
+              "column"
+            ],
+            "properties": {
+              "severity": {
+                "const": "error"
+              },
+              "code": {
+                "enum": ["YMLC101", "YMLC102", "YMLC103", "YMLC104", "YMLC105", "YMLC106"]
+              },
+              "message": {
+                "type": "string",
+                "minLength": 1
+              },
+              "subject": {
+                "type": "string",
+                "minLength": 1
+              },
+              "path": {
+                "type": "string",
+                "minLength": 1
+              },
+              "pointer": {
+                "type": "string",
+                "pattern": "^/"
+              },
+              "line": {
+                "type": "integer",
+                "minimum": 1
+              },
+              "column": {
+                "type": "integer",
+                "minimum": 1
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+}